Skip to main content
PUT
Update CoworkerTask
Updates an existing CoworkerTask record. You must include the Id of the record to update along with all required fields.

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 CoworkerTask-Edit role.

Request Body

Required Fields

integer
required
The Id of the CoworkerTask record to update.
integer
required
ID of the business linked to this record.
integer
required
ID of the coworker linked to this record.
string
required
Task name.
integer
required
ID of the responsible linked to this record.

Optional Fields

string
Additional details or instructions for the task.
string
Unique identifier of the task item within a task list.
boolean
Whether the task has been marked as completed.
string
Due date for the task (UTC).
boolean
Whether a reminder has been sent for this task.
boolean
Whether to notify the responsible admin by email when the task is due.
boolean
Whether the task is visible to all admin users.
string
Due date for the task in the location’s local timezone.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the coworkertask was updated 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