Skip to main content
PUT
Update Assignment

Authorizations

X-Api-Key
string
header
required

Path Parameters

assignment_id
number
required

Assignment ID

Example:

8495

Body

application/json
user
integer
Example:

79786

project
string

Project encoded ID

Example:

"as:981141080110246"

task
string

Task encoded ID

client
integer

Client ID

type
enum<string>
Available options:
project,
client,
task,
time-off
Example:

"project"

startDate
string

Format: Y-m-d

Example:

"2019-01-21"

endDate
string

Format: Y-m-d

Example:

"2019-02-01"

time
integer

Scheduled time in seconds

Example:

252000

note
string

Max 1000 chars

includeWeekends
boolean
color
string

Hex color #rrggbb

sendNotification
boolean
forceOverride
boolean
Example:

true

timeOffType
string

Time-off type (only when type is time-off).

timeOffPeriod
enum<string>

Time-off period (only when type is time-off).

Available options:
full-day,
half-of-day,
quarter-of-day,
half-and-quarter-of-day
status
enum<string>

Time-off approval status (only when type is time-off).

Available options:
pending,
approved

Response

OK

days
number

Number of workdays

Example:

10

endDate
string
Example:

"2019-02-01"

id
number
Example:

41827

project
string
Example:

"as:981141080110246"

startDate
string
Example:

"2019-01-21"

time
number

Scheduled time in seconds

Example:

252000

type
enum<string>
Available options:
project,
time-off
Example:

"project"

user
number
Example:

79786