Skip to main content
PATCH
Update task

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Task sid (ub_tk_…).

Required string length: 18
Pattern: ^ub_tk_

Body

application/json

Request body of update_task.

title
string

Replacement title, 1..255 chars.

Required string length: 1 - 255
body
string | null

Replacement detail (full replace); null clears it.

due_at
string | null

ISO 8601 UTC deadline; null clears the deadline and takes the task out of the due sweep.

expires_at
string | null

ISO 8601 UTC, after now (422 otherwise): the new instant the sweep cancels the open task at; null takes the expiry off. A close (done or canceled) clears it, and so does a reopen past it.

state
enum<string>

done = complete it (completed_at stamped), canceled = discard it, open = reopen it (completed_at and the pick cleared). The service applies the value it is given; it runs no transition guard.

Available options:
open,
done,
canceled
assignee_user_sid
string | null

Reassign the work; null unassigns it.

Required string length: 18
chosen_option_id
integer | null

The arm picked from options. Required with state=done on a task that carries options, and refused (422 chosen_option_id) on one that does not or for an id outside the list.

Required range: x >= 1
draft
string | null

A play's draft, as edited (2026-10-14): the words that go when the task closes done. Kept on any other task but meaningless there.

Maximum string length: 8000
workflow_sid
string | null

A play's question only: the workflow a move or an add puts the person into (play_ref.workflow_sid). Required with state done when the chosen option's key is move or add and the ref names none (422 workflow_sid); 422 on a task that is no play's question.

Required string length: 18

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.