Sign in

v1

latestOpenAPI 3.1.12026-07-124448163.2 KB
tasks

Update a task

Updates a task by ID.

patch/tasks/{id}

Path parameters

idstring cuid required

The ID of the item

Example:cmf41ajzv003706un4i99q19z

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Request body

titlestring

The title of the task

textstring

The text of the task

dueDatestring nullable

The due date of a task

status'IN_PROGRESS' | 'ACCEPTED' | 'OPEN' | 'IN_REVIEW' | 'DECLINED'

The status of the task

destinationFolderIdstring cuid nullable

The ID of the destination folder

assetFileIdsstring[]

The IDs of the files that should be attachement of this task. For example to give extra context to the user who works on this task.

parentIdstring cuid nullable

The ID of the parent task

Example request

{
  "title": "Updated Task Upload Documents",
  "text": "Upload the documents",
  "dueDate": "2021-01-01T00:00:00Z",
  "status": "OPEN",
  "destinationFolderId": "cmf41ajzv003706un4i99q19z",
  "assetFileIds": [
    "cmf41ajzv003706un4i99q19z"
  ],
  "parentId": "cmf41ajzv003706un4i99q19z"
}

Response

Task updated successfully

idstring cuid required

The ID of the task

titlestring required

The title of the task

textstring nullable required

The text of the task

status'IN_PROGRESS' | 'ACCEPTED' | 'OPEN' | 'IN_REVIEW' | 'DECLINED' required

The status of the task

dueDatestring date-time nullable required

The due date of a task. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

workspaceIdstring cuid required

The ID of the workspace

createdByIdstring cuid nullable required

The ID of the creator

actorType'USER' | 'SYSTEM' | 'AI' | 'API' required

The type of the actor

parentIdstring cuid nullable required

The ID of the parent task

destinationFolderIdstring cuid nullable required

The ID of the destination folder where assigned files will be stored

createdAtstring date-time required

The date and time of the creation for the task. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

updatedAtstring date-time required

The date and time of the last update for the task. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example response

{
  "id": "cmf41ajzv003706un4i99q19z",
  "title": "Task 1",
  "text": "Upload the documents",
  "status": "OPEN",
  "dueDate": "2021-01-01T00:00:00Z",
  "workspaceId": "cmf41ajzv003706un4i99q19z",
  "createdById": "cmf41ajzv003706un4i99q19z",
  "actorType": "USER",
  "parentId": "cmf41ajzv003706un4i99q19z",
  "destinationFolderId": "cmf41ajzv003706un4i99q19z",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}