Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
task

Update an existing task

patch/v1/org/{orgId}/task/{taskId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

taskIdstring required

Task id

Request body

status'PENDING' | 'DONE' | 'EXPIRED' | 'SKIPPED'

status of this task

labelstring

The user-visible label for the task; if not set, will automatically default based on the task type

messagestring

The message attached to this task

taskConfigIdstring

id of the TaskConfig

slugstring

slug used to reference tasks in events

dueAtstring

due date for the task

pastDueAction'NONE' | 'SET_EXPIRED'

what action to take when the task is past its due date

isSkippableboolean

check for if the task can be skipped

Example request

{
  "message": "this is the best task ever",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "taskConfigId": "588f7ee98f138b19220041a7",
  "slug": "onboardingForm",
  "pastDueAction": "NONE"
}

Response

task updated