Skip to main content
POST
Create TaskItem
A TaskItem represents an individual task or to-do item that can be assigned to staff or customers. Tasks can be organised into lists, have due dates, and track completion status.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the TaskItem-Create role.

Request Body

Required Fields

integer
required
ID of the task list linked to this record.
integer
required
ID of the responsible linked to this record.
string
required
The name value for this task item.
integer
required
The delay in hours value for this task item.

Optional Fields

boolean
Whether this task item is currently active.
boolean
Whether notify by email is enabled.
boolean
Whether display to everyone is enabled.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the creation.
object
Contains the Id of the newly created record.
boolean
true if the taskitem was created successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response