Sign in
latestOpenAPI 3.1.02026-08-19722176474.5 KB

f1eea337ff61

Tasks Checklist

Create a checklist for a parent task

Append a checklist item to the given parent task. The item is created incomplete and takes the last position in the checklist order.

post/v1/tasks/{taskId}/checklists

Path parameters

taskIdinteger required

ID of the parent task

Headers

X-Org-Idinteger required

Organization ID

Request body

checkListNamestring required

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

assigneeIdinteger

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

Example request

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

Response

Checklist created 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"
}