Skip to main content
POST
Turn a subsequence on

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Maximum string length: 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

id
string<uuid>
required

Subsequence id.

Example:

"5b2f3c4d-6e7f-4a81-9b0c-1d2e3f4a5b6c"

Body

application/json
enrollExisting
boolean
default:false

Also enroll the leads that ALREADY match the trigger (in the background). A lead going through another subsequence right now is not taken out of it. Default false: only new events count from now on.

Example:

false

Response

id
string<uuid>
required
Example:

"5b2f3c4d-6e7f-4a81-9b0c-1d2e3f4a5b6c"

status
enum<string>
required
Available options:
draft,
scheduled,
active,
paused,
stopped,
completed,
failed
Example:

"active"

enabled
boolean
required
Example:

true

state
enum<string>
required

Why it sends or not, in one word: draft - off; starts_with_campaign - on, starts when the draft campaign starts; active - on and sending; paused - paused by you; paused_with_campaign - on, but the campaign is paused; stopped_campaign_ended - the campaign completed, was stopped or deleted; paused_requires_plan - the plan does not include subsequences; cant_start - on, but it cannot start: it has no email, or an email is missing content; waiting_restart - on, waiting for the completed campaign to be restarted.

Available options:
draft,
starts_with_campaign,
active,
paused,
paused_with_campaign,
stopped_campaign_ended,
paused_requires_plan,
cant_start,
waiting_restart
Example:

"active"

enrollingExisting
boolean
required

true when leads that already match the trigger are being enrolled in the background (enrollExisting: true on a running campaign).

Example:

false

success
boolean
required
Example:

true