Tasks

Update task

Updates a task. Linked card tasks have limited update options. Requires board editor permissions.

patch/tasks/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/tasks/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the task to update

Request body

taskListIdstring

ID of the task list to move the task to

assigneeUserIdstring nullable

ID of the user assigned to the task (null to unassign)

positionnumber

Position of the task within the task list

namestring

Name/title of the task

isCompletedboolean

Whether the task is completed

Example request

{
  "taskListId": "1357158568008091265",
  "assigneeUserId": "1357158568008091266",
  "position": 65536,
  "name": "Write unit tests",
  "isCompleted": true
}

Response

Task updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "taskListId": "1357158568008091265",
    "linkedCardId": "1357158568008091266",
    "assigneeUserId": "1357158568008091267",
    "position": 65536,
    "name": "Write unit tests",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.