PATCH
/
v1
/
tasks
/
{id}
Update a task
curl --request PATCH \
  --url https://api.steuerboard.com/v1/tasks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Updated Task Upload Documents",
  "text": "Upload the documents",
  "dueDate": "2021-01-01T00:00:00Z",
  "status": "OPEN",
  "destinationFolderId": "cmf41ajzv003706un4i99q19z",
  "assetFileIds": [
    "cmf41ajzv003706un4i99q19z"
  ],
  "parentId": "cmf41ajzv003706un4i99q19z"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Path Parameters

​
id
string<cuid>
required

The ID of the item

Example:

"cmf41ajzv003706un4i99q19z"

Body

application/json

Task update

​
title
string

The title of the task

Example:

"Updated Task Upload Documents"

​
text
string

The text of the task

Example:

"Upload the documents"

​
dueDate
string | null

The due date of a task

Example:

"2021-01-01T00:00:00Z"

​
status
enum<string>

The status of the task

Available options:
IN_PROGRESS,
ACCEPTED,
OPEN,
IN_REVIEW,
DECLINED
Example:

"OPEN"

​
destinationFolderId
string<cuid> | null

The ID of the destination folder

Example:

"cmf41ajzv003706un4i99q19z"

​
assetFileIds
string<cuid>[]

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.

Example:
["cmf41ajzv003706un4i99q19z"]
​
parentId
string<cuid> | null

The ID of the parent task

Example:

"cmf41ajzv003706un4i99q19z"

Response

Task updated successfully

​
id
string<cuid>
required

The ID of the task

Example:

"cmf41ajzv003706un4i99q19z"

​
title
string
required

The title of the task

Example:

"Task 1"

​
text
string | null
required

The text of the task

Example:

"Upload the documents"

​
status
enum<string>
required

The status of the task

Available options:
IN_PROGRESS,
ACCEPTED,
OPEN,
IN_REVIEW,
DECLINED
Example:

"OPEN"

​
dueDate
string<date-time> | null
required

The due date of a task

Example:

"2021-01-01T00:00:00Z"

​
workspaceId
string<cuid>
required

The ID of the workspace

Example:

"cmf41ajzv003706un4i99q19z"

​
createdById
string<cuid> | null
required

The ID of the creator

Example:

"cmf41ajzv003706un4i99q19z"

​
actorType
enum<string>
required

The type of the actor

Available options:
USER,
SYSTEM,
AI,
API
Example:

"USER"

​
parentId
string<cuid> | null
required

The ID of the parent task

Example:

"cmf41ajzv003706un4i99q19z"

​
destinationFolderId
string<cuid> | null
required

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

Example:

"cmf41ajzv003706un4i99q19z"

​
createdAt
string<date-time>
required

The date and time of the creation for the task

Example:

"2021-01-01T00:00:00Z"

​
updatedAt
string<date-time>
required

The date and time of the last update for the task

Example:

"2021-01-01T00:00:00Z"