Skip to main content
POST
Launch a sequence

Authorizations

Authorization
string
header
required

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

Path Parameters

sequence_id
string<uuid>
required

Response

Successful Response

audience_table_id
string<uuid> | null
required
audience_view_id
string<uuid> | null
required
column_mapping
ColumnMappingSchema · object
required
created_at
string<date-time>
required
edges
SequenceEdgeSchema · object[]
required
id
string<uuid>
required
launched_at
string<date-time> | null
required
multithreading
Multithreading · object | null
required
name
string
required
pause_reason
string | null
required
sending_window
Sending Window · object | null
required
status
enum<string>
required

Lifecycle of a sequence.

DRAFT until launch; RUNNING sequences are locked against structural edits (pause → edit → resume); PAUSED stops scheduling while leaving every enrolment exactly where it is; COMPLETED is terminal.

Available options:
draft,
running,
paused,
completed
status_column_id
string<uuid> | null
required
step_count
integer
required
steps
SequenceStepSchema · object[]
required
updated_at
string<date-time>
required
ai_cta_label
string | null
ai_cta_url
string | null
ai_goal
string | null
ai_language
string | null
ai_reply_mode
enum<string> | null

How far the AI reply layer may go on this sequence.

Auto-drafting is PHASE2 §8; the self-sending auto-pilot is INB-15. OFF is the default everywhere: a workspace opts in. AUTO_SEND is a further EXPLICIT opt-in: a HIGH-confidence draft on a healthy thread is approved automatically — through the exact same approve path a human uses, so sending stays one code path — while anything uncertain (lower confidence, a Negative/Wrong-contact label, OOO, a bounce, or a thread the agent has already answered five times) waits in Needs approval exactly like DRAFT_AND_QUEUE. An auto-sent draft records NO approver: a NULL approved_by_user_id on a SENT draft is the honest audit trail.

Available options:
off,
draft_and_queue,
auto_send
ai_tone
enum<string> | null

How a generated reply should read.

Available options:
professional,
friendly,
direct,
casual
ai_translate
boolean | null
bcc_addresses
string[]

SEQ-21: blind copies on every email this sequence sends.

cc_addresses
string[]

SEQ-21: addresses copied on every email this sequence sends.

connection_requests_sent
integer | null
connections_accepted
integer | null

SEQ-06: invitations from this sequence confirmed accepted. With connection_requests_sent this yields the acceptance rate.

contacts_added
integer | null

§21 rollup, list reads only. None when the rollup has never run for this org — show a zero state, not a fake 0.

contacts_failed
integer | null
contacts_finished
integer | null
contacts_in_progress
integer | null
emails_sent
integer | null
last_synced_at
string<date-time> | null

§20: when the audience-enrolment diff last completed. None until the first sync (launch runs one inline) — the Audience tab shows this plus a manual trigger, never a background job the user cannot see.

linkedin_check_max_seconds
integer | null
linkedin_check_min_seconds
integer | null
linkedin_messages_sent
integer | null
opportunity_values
Opportunity Values · object | null

SEQ-23: dollars per outcome label; None = tracking off.

plain_text_only
boolean
default:true

SEQ-16: TRUE (recommended) sends text-only with formatting marks stripped; FALSE sends a multipart/alternative with the marks as HTML.

positive
integer | null

Threads labelled positive (rollup, list reads only).

positive_rate
number | null
replies
integer | null

SEQ-06: distinct contacts who replied — reply_rate's numerator.

reply_rate
number | null
sender_profile_names
string[]

Only meaningful on list reads: the assigned sender profiles' names.

senders_ready
boolean
default:true

Only meaningful on list reads: False when the sequence has assigned sender profiles but none currently has a connected mailbox.

sending_priority
string
default:new_contacts

SEQ-20: who gets scarce capacity first — new_contacts or follow_ups.