Skip to main content
POST
Cancel 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 cancel_workflow_task.

reason
string

Why the step is skipped - stored in the workflow-tasks.finished event payload only (not on the row).

Maximum string length: 512

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