Create a Sequence

post

https://api.apollo.io/api/v1/sequences/create

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 1 or more emailer_touches (email variants); adding more than 1 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.

This endpoint requires a master API key. If you attempt to call the endpoint without a master key, you will receive a 403 response. Refer to Create API Keys to learn how to create a master API key.

Body Params

name

string

A human-readable name for the sequence.

Example: Q3 Outbound Outreach

permissions

string

Set who can use or view the sequence within your team. Choose 1 of the following options:

team_can_use: All team members can use the sequence. (default)
team_can_view: Team members can view, but not use, the sequence.
private: Only the sequence owner can view and use the sequence.

active

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.

emailer_schedule_id

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.

user_id

string

The Apollo user ID for the owner of the sequence. Defaults to the user that owns the API key.

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

folder_id

string

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

sequence_by_exact_daytime

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).

max_emails_per_day

integer

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

mark_finished_if_reply

boolean

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

mark_finished_if_click

boolean

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

mark_finished_if_interested

boolean

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

mark_paused_if_ooo

boolean

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

days_to_wait_before_mark_as_response

integer

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

create_task_if_email_open

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.

email_open_trigger_task_threshold

integer

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

same_account_reply_delay_days

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

ignore_apollo_global_email_bounce_list

boolean

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

sequence_ruleset_id

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

Create a Sequence

What’s Next

What’s Next

200200

401401

403403

422422

429429

What’s Next

What’s Next