Create a Sequence

Endpoint essentials
API key accessapi/v1/sequences/create or Master API key
OAuth scopesemailer_campaigns_create
Credit usage0 credits
Learn more about API pricing and credits.

Sequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Create a Sequence endpoint to create a new sequence in your team's Apollo account, including its steps and email templates.

To create a sequence with steps, add the emailer_steps array to the request body. Each email step (auto_email, manual_email) can include one or more emailer_touches (email variants); adding more than one touch to a step creates an A/B test, which requires a plan with A/B testing access.

To activate the sequence immediately after creation, set active to true. Email touches only send if their status is approved, and a touch can only be approved if its template has a non-empty body.

Who owns a sequence created via API

The new sequence is owned by the user your request acts as, returned as object_owner_id (and its alias, user_id). With an API key that user isn't the teammate who created the key, so expect object_owner_id to differ from that teammate's profile — see Authentication for how the acting user is resolved and how to confirm it.

This endpoint ignores user_id in the request body, so you can't choose the owner at creation time. To reassign ownership afterward, call Update a Sequence with a user_id.

Body Params
string

A human-readable name for the sequence.

Example: Q3 Outbound Outreach

string
deprecated

Deprecated. This parameter is still accepted, but it no longer controls who can access the sequence and it is no longer returned in any sequence response.

New sequences are created with restricted visibility, so only the owner can access the sequence until it is shared. To share it, call the Update a Sequence endpoint with the sharing_permission object.

boolean

Set to true to activate the sequence immediately after creation so contacts added to it start receiving steps. If omitted or false, the sequence is created in an inactive state.

string

The Apollo ID for the schedule that controls the days and times emails are sent. The schedule must belong to your team and must not be empty.

string

Ignored by this endpoint. The new sequence is always owned by the user your request acts as, returned as object_owner_id (alias user_id) — see Authentication for which user that is.

To assign a different owner, create the sequence and then call the Update a Sequence endpoint with the user_id you want.

label_names
array of strings

Add the names of lists (labels) to apply to the sequence. Labels that do not exist yet are created.

Example: ["Outbound", "Q3"]

label_names
string

The Apollo ID for the folder in which to place the sequence.

boolean

Set to true to schedule every step at an exact date and time (exact_datetime becomes required on each step) instead of using relative wait intervals (wait_time/wait_mode).

integer

The maximum number of emails the sequence sends per day. Must not be negative.

boolean

Set to true to mark contacts as finished in the sequence when they reply to an email.

boolean

Set to true to mark contacts as finished in the sequence when they click a link in an email.

boolean

Set to true to mark contacts as finished in the sequence when they are marked as interested.

boolean

Set to true to pause contacts in the sequence when an out-of-office auto-reply is detected.

integer

The number of days to wait before an incoming email is no longer treated as a response to the sequence.

boolean

Set to true to automatically create a task when a contact opens an email a certain number of times. Use email_open_trigger_task_threshold to set the number of opens.

integer

The number of email opens that triggers task creation when create_task_if_email_open is true.

integer

The number of days to pause other contacts at the same account after a reply is received. The maximum value is 1000.

excluded_account_stage_ids
array of strings

The Apollo IDs for account stages to exclude from the sequence. All IDs must belong to your team.

excluded_account_stage_ids
excluded_contact_stage_ids
array of strings

The Apollo IDs for contact stages to exclude from the sequence. All IDs must belong to your team.

excluded_contact_stage_ids
boolean

Set to true to send emails to contacts even if their email address is on Apollo's global bounce list.

string

The Apollo ID for an existing sequence ruleset to apply shared sequence settings.

emailer_steps
array of objects

The steps to create in the sequence. Steps run in the order they appear in this array; the first item becomes the first step. There is no separate ordering field on input.

emailer_steps
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain