Skip to main content
PATCH
This endpoint allows you to update a task with provided details. You must provide either identifier parameter or an external reference via the external_ref attribute. All datetime fields included in the body parameters need to be specified as ISO8601-formatted date strings. Datetime fields should follow a “YYYY-MM-DDThh:mm:ss” format.
string
default:"none"
required
The authentication token for your request

Body

string
default:"none"
The identifier of a task to use for updating a task.Please note you can either use the identifier or external_ref to update a task.
string
default:"none"
The external reference of a task to use for updating a task.Please note you can either use the identifier or external_ref to update a task.
enum
default:"none"
The status of a task.Possible values: created, in_progress, completed, error or deleted
datetime
default:"none"
The due date of the task. Example: 2023-01-01T00:00:00
string
default:"none"
The reminder date of a task. Example: 2023-01-01T00:00:00
string
default:"none"
The completed date of the task. Example: 2023-01-01T00:00:00
enum
default:"none"
The importance of the task. Possible value: low, normal, high, very_high.
string
default:"none"
The identifier of task assignee. You can use this field to update the task assignee.
string
default:"none"
The identifier of the resident that the task is targeted for. You can use this field to update the task resident.
string
default:"none"
The notes of the task.
string
default:"none"
The title of the task.
string
default:"none"
The description of the task.

Response

string
The UUID of the request. We handle requests asynchronously, the task update result will be sending by webhook event. You can use this ID to lookup webhook event on consumer application portal.