Skip to main content
POST
Restart workflow record from top

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 record sid (wf_rc_…).

Required string length: 18
Pattern: ^wf_rc_

Body

application/json

Request body of restart_workflow_record.

mode
enum<string>

from_start (default): the journey begins at the published version's entry step. from_current: it keeps the step it is on (the entry when the published version no longer has that step).

Available options:
from_start,
from_current
sender_profile_sid
string

An explicit sender profile for the restarted journey; it must be in the workflow's sender pool (422 otherwise). Absent = the workflow's rotation strategy picks again.

Required string length: 18
Pattern: ^ub_sp_
reason
string

Free-form; stored in the workflow_restarted activity and the log 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