Skip to main content
POST
Move leads into a subsequence

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
leadIds
string<uuid>[]

Lead ids of the MAIN campaign (GET /v1/campaigns/{id}/leads). Pass leadIds or emails, not both.

Maximum array length: 1000
Example:
emails
string[]

Emails of leads of the MAIN campaign (case-insensitive). Pass leadIds or emails, not both.

Maximum array length: 1000
Example:
start
object

When the first email goes out. Default { "mode": "now" }. Overrides the subsequence's settings.start for these leads.

Response

enrolled
number
required

Leads that entered the subsequence (their remaining main-sequence emails are canceled).

Example:

18

skipped
object
required

Leads that did not enter, by reason: not_contacted (never emailed - a subsequence continues a conversation), already_enrolled (a lead enters each subsequence once), suppressed (unsubscribed, bounced or blacklisted), company_replied (a colleague at the same company replied in the campaign or one of its subsequences, and the campaign stops the company on a reply), lead_removed, not_accepting (the campaign is not active or paused - draft, completed, stopped or deleted -, the subsequence is completed or deleted, or the plan does not include subsequences; a subsequence that is paused or was never turned on still takes leads), thread_unavailable (step 1 replies in the same thread but the conversation's thread could not be found). Any other key also means the lead did not enter.

Example:
notFound
number
required

Requested lead ids / emails that are not leads of the main campaign.

Example:

0