v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Task

Update task

Update a task by id. This endpoint currently only supports updating task status.

Permissions required: Permission to edit the containing page or blog post and view its corresponding space.

put/tasks/{id}

Path parameters

idinteger required

The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results.

Query parameters

body-format'storage' | 'atlas_doc_format'

The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.

The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

Request body

idstring

ID of the task.

localIdstring

Local ID of the task. This ID is local to the corresponding page or blog post.

spaceIdstring

ID of the space the task is in.

pageIdstring

ID of the page the task is in.

blogPostIdstring

ID of the blog post the task is in.

status'complete' | 'incomplete' required

Status of the task.

createdBystring

Account ID of the user who created this task.

assignedTostring

Account ID of the user to whom this task is assigned.

completedBystring

Account ID of the user who completed this task.

createdAtstring date-time

Date and time when the task was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

updatedAtstring date-time

Date and time when the task was updated. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

dueAtstring date-time

Date and time when the task is due. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

completedAtstring date-time

Date and time when the task was completed. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

Response

Returned if the requested task is updated.