v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Sequences

Create a Sequence

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Create a Sequence endpoint to create a new sequence in your team's Apollo account, including its steps and email templates.<br><br>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.<br><br>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.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.

post/sequences

Request body

namestring

A human-readable name for the sequence. <br><br>Example: Q3 Outbound Outreach

permissionsstring

Set who can use or view the sequence within your team. Choose 1 of the following options: <ul><li>team_can_use: All team members can use the sequence. (default)</li><li>team_can_view: Team members can view, but not use, the sequence.</li><li>private: Only the sequence owner can view and use the sequence.</li></ul>

activeboolean

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_idstring

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_idstring

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

label_namesstring[]

Add the names of lists (labels) to apply to the sequence. Labels that do not exist yet are created. <br><br>Example: ["Outbound", "Q3"]

folder_idstring

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

sequence_by_exact_daytimeboolean

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_dayinteger

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

mark_finished_if_replyboolean

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

mark_finished_if_clickboolean

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

mark_finished_if_interestedboolean

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

mark_paused_if_oooboolean

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

days_to_wait_before_mark_as_responseinteger

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

create_task_if_email_openboolean

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_thresholdinteger

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

same_account_reply_delay_daysinteger

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_idsstring[]

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

excluded_contact_stage_idsstring[]

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

ignore_apollo_global_email_bounce_listboolean

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

sequence_ruleset_idstring

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

Response

200

attachmentsobject[]

Example response

{
  "emailer_campaign": {
    "id": "68b1f3a2e1d2c40001a23b45",
    "name": "Q3 Outbound Outreach",
    "active": true,
    "permissions": "team_can_use",
    "user_id": "60affe7d6e270a00f5db6fe4",
    "emailer_schedule_id": "66e9e215ece19801b2199900",
    "num_steps": 2,
    "creation_type": "new",
    "created_at": "2026-06-12T10:15:30.000Z"
  },
  "emailer_steps": [
    {
      "id": "68b1f3a2e1d2c40001a23b46",
      "emailer_campaign_id": "68b1f3a2e1d2c40001a23b45",
      "position": 1,
      "type": "auto_email",
      "wait_time": 3,
      "wait_mode": "day"
    }
  ],
  "emailer_touches": [
    {
      "id": "68b1f3a2e1d2c40001a23b48",
      "emailer_step_id": "68b1f3a2e1d2c40001a23b46",
      "emailer_template_id": "68b1f3a2e1d2c40001a23b4a",
      "status": "approved",
      "type": "new_thread"
    }
  ],
  "emailer_templates": [
    {
      "id": "68b1f3a2e1d2c40001a23b4a",
      "subject": "Quick question, {{first_name}}",
      "body_html": "<p>Hi {{first_name}},</p>"
    }
  ]
}