Skip to main content
PATCH
Update workflow 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

Workflow task sid (wf_tk_…).

Required string length: 18
Pattern: ^wf_tk_

Body

application/json

Request body of update_workflow_task.

variables_snapshot
object

Partial: the rendered text fields to replace, keyed by the type's template field (message / subject / body / comment / prompt / title / instructions). Unknown keys and over-cap values → 422.

scheduled_at
string<date-time>

When the task may run (ISO 8601). A past time clamps to now = "send now".

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.