Skip to main content
POST
Create a subtask

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

taskId
string<uuid>
required

Body

Data transfer object for a subtask.

staffId
string
required

Unique identifier of the associated staff member creating or updating the subtask.

Minimum string length: 1
Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

subject
string
required

Subject of the subtask.

Minimum string length: 1
Example:

"Confer with Mary"

completedByStaffId
string | null

Unique identifier of the associated staff member who completed the subtask.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

isCompleted
boolean

True when the subtask is completed.

Example:

false

completedDate
string<date-time> | null
deprecated

Deprecated. Use CompletedDateOnly instead.

Completed date of the subtask in UTC. If not provided and IsCompleted is set to true, the current date will be used.

Example:

"2020-02-15T13:00:00Z"

completedDateOnly
string<date-time> | null

Completed date of the subtask. Takes precendence over CompletedDate if set. If not provided and IsCompleted is set to true, the current date will be used.

Any time/timezone information will be discarded and only the date portion will be considered.

Example:

"2020-02-15"

Response

When request is accepted. Returns a hypermedia 'Link' object of the subtask to be created.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET