Skip to main content
POST
Add people to workflow source

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

Manual source (wf_sr_…, type=manual) - any other type → 422 validation_failed.

Required string length: 18
Pattern: ^wf_sr_

Body

application/json

Request body of add_workflow_source_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

People ALREADY in the workflow. Omitted: a terminal record restarts from_start, an in-flight one is skipped (skipped_in_flight_count). from_start | from_current also re-run in-flight records (from_current: the pinned step); terminal ones restart anyway.

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