POST
/
v2
/
project
curl --request POST \
  --url https://api.sonderplan.com/v2/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Andor S1 EP7 Annoucement",
  "code": "AND-S1-EP7",
  "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
  "status_id": 1,
  "status": [
    {
      "name": "Second Hold",
      "description": "Has second priority if the first hold cancels",
      "notification": true
    }
  ],
  "private": 0,
  "parent_folder_id": 5,
  "color_background": "#B0A7F1",
  "color_text": "#000000",
  "start": 1547501100,
  "end": 1547538900,
  "client_id": "p23987",
  "client": [
    {
      "uuid": "p4",
      "contact_person": {
        "id": 2837
      }
    }
  ],
  "custom_fields": [
    {
      "id": 7823,
      "name": "Type",
      "value": "Video Editing",
      "value_id": 8973,
      "update_key": "2_1_7823"
    }
  ],
  "people": {
    "users": [
      {
        "id": 4,
        "name": "Jane Smith",
        "admin_flag": 0,
        "role_id": 0,
        "role_name": 0,
        "project_admin": true,
        "group_write_admin": false
      }
    ]
  },
  "time_entries": [
    {
      "owner_id": 872383,
      "name": "Colour Grading",
      "description": "Opening scenes completed",
      "start": 1547501100,
      "end": 1547538900,
      "booking_id": 872383
    }
  ]
}'
{
  "success": {
    "id": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
Project object that needs to be added

The default project schema which contains the majority of these fields

​
name
string
required

Title of the project

Example:

"Andor S1 EP7 Annoucement"

​
code
string

Short code used to identify the project

Example:

"AND-S1-EP7"

​
description
string

A short description or synopsis of the project

Example:

"Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization."

​
status_id
integer

Project Status ID

Example:

1

​
status
object[]

A simplified version of the complete Status Model

​
private
boolean

Is the project viewable to everyone, or just the users and groups assigned

Example:

0

​
parent_folder_id
integer

The ID of the folder that this project is sitting in

Example:

5

​
color_background
string

Hex color value of the background

Example:

"#B0A7F1"

​
color_text
string

Hex color value of the text

Example:

"#000000"

​
start
integer

Unix Timestamp of the project start time frame.

Example:

1547501100

​
end
integer

Unix timestamp of the project end time frame.

Example:

1547538900

​
client_id
string

The ID of the client prefixed by either p (for person) or o (for organization)

Example:

"p23987"

​
client
object[]

The client (either person or organization) attached to this project

Client model with some fields

​
custom_fields
object[]

Used to show the values of custom fields on linked modules

​
people
object

The users and groups assigned to this project. Also contains information regarding project admin status and role information

​
time_entries
object[]

The time entries attached to a project

Response

200
application/json
Successful Operation
​
success
object