Skip to main content
POST
Add people to workflow

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

The workflow (wf_wf_…), with a published version.

Required string length: 18
Pattern: ^wf_wf_

Body

application/json

Request body of add_workflow_people.

people_sids
string[]
required

1..500 people (cr_pp_…). Any unknown sid → 422 relation_not_found and the WHOLE call is rejected (nothing partial).

Required array length: 1 - 500 elements
Required string length: 18
Pattern: ^cr_pp_
restart
enum<string> | null

Run everyone the workflow holds already again, on purpose: from_start from the top, from_current from the pinned step (a terminal journey restarts from the top either way). Omitted: they stay as they are (skipped_enrolled_count).

Available options:
from_start,
from_current

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