Sign in

v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB
Schedule

Create Assignment

Create a schedule assignment. To create time-off use POST /resource-planner/assignments/time-off instead.

post/resource-planner/assignments

Request body

userinteger
projectstring

Project encoded ID

taskstring

Task encoded ID

clientinteger

Client ID

type'project' | 'client' | 'task' | 'time-off'
startDatestring required

Format: Y-m-d

endDatestring required

Format: Y-m-d

timeinteger

Scheduled time in seconds

notestring

Max 1000 chars

includeWeekendsboolean
colorstring

Hex color #rrggbb

sendNotificationboolean
forceOverrideboolean
timeOffTypestring

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

timeOffPeriod'full-day' | 'half-of-day' | 'quarter-of-day' | 'half-and-quarter-of-day'

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

status'pending' | 'approved'

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

usersinteger[]

Create the same schedule for multiple users (create only).

reviewerinteger

Reviewer user ID for time-off (create only).

Example request

{
  "user": 79786,
  "project": "as:981141080110246",
  "type": "project",
  "startDate": "2019-01-21",
  "endDate": "2019-02-01",
  "time": 252000,
  "forceOverride": true,
  "users": [
    79786,
    80012
  ]
}

Response

OK

daysnumber

Number of workdays

endDatestring
idnumber
projectstring
startDatestring
timenumber

Scheduled time in seconds

type'project' | 'time-off'
usernumber

Example response

{
  "days": 10,
  "endDate": "2019-02-01",
  "id": 41827,
  "project": "as:981141080110246",
  "startDate": "2019-01-21",
  "time": 252000,
  "type": "project",
  "user": 79786
}