Skip to main content
POST
Complete 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 complete_workflow_task.

note
string

Outcome note - stored in result.note and in the manual_task_completed activity payload.

Maximum string length: 2000
choice
enum<string>

A play's question (act.do = ask): one of act.options. remove = the journey ends; keep = it goes on; move = it ends and the person enters workflow_sid (default: the act's target); add = a person in no journey enters workflow_sid. Required on a question.

Available options:
remove,
keep,
move,
add
workflow_sid
string

The workflow a move or an add puts the person into, when the act names none.

Required string length: 18
Pattern: ^wf_wf_

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required