Skip to main content
POST
Launch an outbound sequence — arms candidates for sending

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sequenceId
string<uuid>
required

The unique identifier of the sequence

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

status
string
required
Allowed value: "active"
activated
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
held_suppressed
integer
required

Candidates held back because their identity is suppressed — never armed.

Required range: -9007199254740991 <= x <= 9007199254740991