Sign in
latestOpenAPI 3.1.02026-08-20723176475.4 KB

c2b39b2c43c5

Tasks Checklist

Update a checklist of a parent task

Replace name, completion state and assignee of the given checklist item. Every field is applied as sent, so omitting assigneeId unassigns the item.

put/v1/tasks/{taskId}/checklists/{checklistId}

Path parameters

taskIdinteger required

ID of the parent task

checklistIdinteger required

ID of the checklist item to update

Headers

X-Org-Idinteger required

Organization ID

Request body

checkListNamestring required

Name of the checklist item. Must be between 3 and 150 characters.

completedboolean required

Completion state of the checklist item.

assigneeIdinteger

User ID the checklist item is assigned to. The user must be an active member of the organisation. Omit to unassign the item.

Example request

{
  "checkListName": "Review the API contract",
  "completed": true,
  "assigneeId": 42
}

Response

Checklist updated successfully

successboolean

Indicates if the operation was successful

messagestring

Message describing the result of the operation

codeinteger

HTTP status code of the response

timestampstring date-time

Timestamp of the response

Example response

{
  "success": true,
  "message": "Operation completed successfully",
  "code": 200,
  "timestamp": "2023-01-01T12:00:00Z"
}