Skip to content

Create Sequence

POST
/sequences

Create a new sequence with optional steps and channels.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
associated_list_id
Any of:
integer
campaign_id
Any of:
string
channels
Any of:
Array<object>
object
channel_data
Any of:
object
key
additional properties
any
channel_id
required

Channel resource ID (mailbox ID, phone ID, etc.)

integer
channel_type
required

Channel type. One of: SMTP, GMAIL, INBOXKIT, PHONE, LINKEDIN, SMS, WHATSAPP. Case-insensitive.

string
channel_value
required

Channel value (email address, phone number, etc.)

string
description
Any of:
string
finish_on_reply

Stop contacting on reply

boolean
default: true
name
required

Sequence name

string
pinned_mailbox_id
Any of:
integer
send_in_same_thread

Send follow-ups in same email thread

boolean
sequence_kind
Any of:
string
steps
Any of:
Array<object>
object
input_type

Input type. One of: ON_DEMAND, MANUAL_TEMPLATE, AI_GENERATED_TEMPLATE. Case-insensitive aliases accepted (e.g. ‘template’ -> MANUAL_TEMPLATE, ‘ai’ -> AI_GENERATED_TEMPLATE).

string
default: ON_DEMAND
step_data
Any of:
object
key
additional properties
any
step_order
required

Order of the step in the sequence (1-based)

integer
step_type
required

Step type. One of: EMAIL, PHONE, SMS, WHATSAPP, HEYREACH, MANUAL_DIALER. Note: LinkedIn outreach uses HEYREACH (not LINKEDIN). Case-insensitive aliases accepted.

string
time_interval

Delay in seconds after the previous step

integer
user_email
required

Owner email address

string
wait_for_new_contacts

Keep sequence waiting for new contacts

boolean

Responses

201

Successful Response

object
data
required
object
created_at
Any of:
string
id
required
string
name
required
string
status
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string