v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Sequences

Add Contacts to 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. Use the Add Contacts to a Sequence endpoint to add contacts to the existing sequences in your team's Apollo account. A contact is a person that your team has explicitly added to your database. Only contacts can be added to sequences. To enrich a person's data, call the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment endpoint</a>. Then, to add the person as a contact in your database, call the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a>. 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/emailer_campaigns/{sequence_id}/add_contact_ids

Path parameters

sequence_idstring required

The Apollo ID for the sequence to which you want to add contacts. To find sequence IDs, call the <a href="https://docs.apollo.io/reference/search-for-sequences" target="_blank">Search for Sequences endpoint</a> and identify the id value for the sequence. Example: 66e9e215ece19801b219997f

Query parameters

emailer_campaign_idstring required

The same ID as the sequence_id. Example: 66e9e215ece19801b219997f

contact_ids[]string[]

The Apollo IDs for the contacts that you want to add to the sequence. To find contact IDs, call the <a href="https://docs.apollo.io/reference/search-for-contacts" target="_blank">Search for Contacts endpoint</a> and identify the id value for the contact. Example: 66e34b81740c50074e3d1bd4 Note: Either contact_ids[] or label_names[] must be provided.

label_names[]string[]

Alternative to contact_ids[]. Array of label names to identify contacts to add to the sequence. Contacts with these labels will be added to the sequence. Note: Either contact_ids[] or label_names[] must be provided.

string required

Single email account ID.

string[] required

One or more email account IDs.

The Apollo ID(s) for the email account(s) used to send to contacts you add to the sequence. Accepts either one id as a string, or multiple ids as an array of strings (multi-mailbox / rotation). To find email account IDs, call the <a href="https://docs.apollo.io/reference/get-a-list-of-email-accounts" target="_blank">Get a List of Email Accounts endpoint</a> and identify the id value for each email account. Examples: 6633baaece5fbd01c791d7ca (string) or ["6633baaece5fbd01c791d7ca", "6633baaece5fbd01c791d7cb"] (array).

send_email_from_email_addressstring

Optional specific email address to send from within the email account.

sequence_no_emailboolean

Set to true if you want to add contacts to the sequence even if they do not have an email address.

sequence_unverified_emailboolean

Set to true if you want to add contacts to the sequence if they have an unverified email address.

sequence_job_changeboolean

Set to true if you want to add contacts to the sequence even if they have recently changed jobs.

sequence_active_in_other_campaignsboolean

Set to true if you want to add contacts to the sequence even if they have been added to other sequences. This parameter does not differentiate between active and paused sequences.

sequence_finished_in_other_campaignsboolean

Set to true if you want to add contacts to the sequence if they have been marked as finished in another sequence.

sequence_same_company_in_same_campaignboolean

Set to true if you want to add contacts to the sequence even if other contacts from the same company are already in the sequence.

contacts_without_ownership_permissionboolean

Set to true if you want to add contacts even if you don't have ownership permission for them.

add_if_in_queueboolean

Set to true if you want to add contacts even if they are currently in the queue for processing.

contact_verification_skippedboolean

Set to true if you want to skip contact verification during the addition process.

user_idstring

The ID for the user in your team's Apollo account. This is the user taking the action to add contacts to a sequence. When the sequence is updated, the activity log shows the user that added the contacts. Use the <a href="https://docs.apollo.io/reference/get-a-list-of-users" target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all of the users within your Apollo account. Example: 66302798d03b9601c7934ebf

status'active' | 'paused'

Initial status for added contacts. When set to paused along with auto_unpause_at, enables scheduled addition of contacts.

auto_unpause_atstring date-time

DateTime when paused contacts should be automatically unpaused. Must be used with status=paused. Format: ISO 8601 datetime string.

Response

200

signals_hashobject nullable

Optional signals data for play recommendations and analytics

Example response

{
  "team": {
    "id": "6095a710bd01d100a506d4ac"
  }
}