{ "item": [ { "id": "aa763e4d-47b1-4733-a132-344d7e0b9a2d", "name": "Sequences", "description": { "content": "Manage outreach sequences and the contacts enrolled in them.", "type": "text/plain" }, "item": [ { "id": "77cc477b-8264-4016-a126-e4d2453e7ea5", "name": "List Email Schedules", "request": { "name": "List Email Schedules", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_schedules/index` or `Master API key`\n\n**OAuth scopes:** `emailer_schedules_list`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSending schedules control the days and times that Apollo sends emails for your sequences. You can configure multiple sending schedules for different sequences, for example to match your audience's time zone or when your contacts are most likely to engage.

Use the List Email Schedules endpoint to retrieve every sending schedule that has been created for your team's Apollo account. For each schedule, the response returns its ID, name, time zone, weekly sending windows, and whether it is your team's default schedule.

Use a schedule's `id` as the `emailer_schedule_id` when you create a sequence or update a sequence to control when that sequence's emails are sent.", "type": "text/plain" }, "url": { "path": [ "emailer_schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d021346b-c2c3-451f-9a62-7e346fa92233", "name": "200", "originalRequest": { "url": { "path": [ "emailer_schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"emailer_schedules\\\": [\\n {\\n \\\"id\\\": \\\"6605a1f2e4b0c80012a3d456\\\",\\n \\\"name\\\": \\\"Normal Business Hours\\\",\\n \\\"default\\\": true,\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"schedule_hash\\\": {\\n \\\"monday\\\": [[8, 17]],\\n \\\"tuesday\\\": [[8, 17]],\\n \\\"wednesday\\\": [[8, 17]],\\n \\\"thursday\\\": [[8, 17]],\\n \\\"friday\\\": [[8, 17]]\\n },\\n \\\"created_at\\\": \\\"2024-03-28T18:56:24.067Z\\\",\\n \\\"use_contacts_time_zone\\\": true,\\n \\\"skip_holidays\\\": true\\n },\\n {\\n \\\"id\\\": \\\"6605a2b7e4b0c80012a3d789\\\",\\n \\\"name\\\": \\\"West Coast Afternoons\\\",\\n \\\"default\\\": false,\\n \\\"time_zone\\\": \\\"America/New_York\\\",\\n \\\"schedule_hash\\\": {\\n \\\"monday\\\": [[12, 17]],\\n \\\"wednesday\\\": [[12, 17]],\\n \\\"friday\\\": [[12, 17]]\\n },\\n \\\"created_at\\\": \\\"2024-04-02T14:10:05.512Z\\\",\\n \\\"use_contacts_time_zone\\\": false,\\n \\\"skip_holidays\\\": true\\n }\\n ]\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3d7084-a2e7-419e-9b52-f9d0a9ffcd9c", "name": "401", "originalRequest": { "url": { "path": [ "emailer_schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34a4d032-bac7-42f6-aae8-a0f5537c9ab1", "name": "403", "originalRequest": { "url": { "path": [ "emailer_schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_schedules/index. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "644c6d4d-5761-495a-959c-f81822238b47", "name": "429", "originalRequest": { "url": { "path": [ "emailer_schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_schedules is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5d14359-1f9d-4cda-9882-38418a244a86", "name": "Search for Sequences", "request": { "name": "Search for Sequences", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/search` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_search`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Search for Sequences endpoint to search for the sequences that have been created for your team's Apollo account.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q_name", "value": "", "description": "Add keywords to narrow the search of the sequences in your team's Apollo account.

Keywords should directly match at least part of a sequence's name. For example, searching the keyword `marketing` might return the result `NY Marketing Sequence`, but not `NY Marketer Conference 2025 attendees`.

This parameter only searches sequence names, not other sequence fields.

Example: `marketing conference attendees`" }, { "disabled": false, "key": "page", "value": "", "description": "The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`" }, { "disabled": false, "key": "per_page", "value": "", "description": "The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance.

Use the `page` parameter to search the different pages of data.

Example: `10`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "46c09868-2d10-4812-90f4-1f387d5a7f2f", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q_name", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 5,\n \"total_entries\": 1,\n \"total_pages\": 1\n },\n \"breadcrumbs\": [\n {\n \"label\": \"Name\",\n \"signal_field_name\": \"q_name\",\n \"value\": \"Copywriting Dublin\",\n \"display_name\": \"Copywriting Dublin\"\n }\n ],\n \"emailer_campaigns\": [\n {\n \"id\": \"66e9e215ece19801b219997f\",\n \"name\": \"Target Copywriting Clients in Dublin\",\n \"archived\": false,\n \"created_at\": \"2024-09-17T20:09:57.837Z\",\n \"emailer_schedule_id\": \"6095a711bd01d100a506d52a\",\n \"max_emails_per_day\": null,\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"same_account_reply_policy_cd\": null,\n \"excluded_account_stage_ids\": [\n \"6095a710bd01d100a506d4b8\",\n \"6095a710bd01d100a506d4b9\",\n \"6095a710bd01d100a506d4ba\",\n \"6095a710bd01d100a506d4bb\"\n ],\n \"excluded_contact_stage_ids\": [\n \"6095a710bd01d100a506d4b5\",\n \"6095a710bd01d100a506d4b4\",\n \"6095a710bd01d100a506d4b0\",\n \"6095a710bd01d100a506d4b1\"\n ],\n \"contact_email_event_to_stage_mapping\": {},\n \"label_ids\": [\n \"66e9e215ece19801b2199980\",\n \"66e9e215ece19801b2199981\",\n \"66e9e215ece19801b2199982\"\n ],\n \"create_task_if_email_open\": false,\n \"email_open_trigger_task_threshold\": 3,\n \"mark_finished_if_click\": false,\n \"active\": false,\n \"days_to_wait_before_mark_as_response\": 5,\n \"starred_by_user_ids\": [\n \"66302798d03b9601c7934ebf\"\n ],\n \"mark_finished_if_reply\": true,\n \"mark_finished_if_interested\": true,\n \"mark_paused_if_ooo\": true,\n \"sequence_by_exact_daytime\": null,\n \"last_used_at\": null,\n \"sequence_ruleset_id\": \"6095a711bd01d100a506d4e0\",\n \"folder_id\": null,\n \"same_account_reply_delay_days\": 30,\n \"is_performing_poorly\": false,\n \"num_contacts_email_status_extrapolated\": 0,\n \"remind_ab_test_results\": false,\n \"ab_test_step_ids\": [],\n \"prioritized_by_user\": null,\n \"creation_type\": \"new\",\n \"num_steps\": 3,\n \"unique_scheduled\": 0,\n \"unique_delivered\": 0,\n \"unique_bounced\": 0,\n \"unique_opened\": 0,\n \"unique_hard_bounced\": 0,\n \"unique_spam_blocked\": 0,\n \"unique_replied\": 0,\n \"unique_demoed\": 0,\n \"unique_clicked\": 0,\n \"unique_unsubscribed\": 0,\n \"bounce_rate\": 0,\n \"hard_bounce_rate\": 0,\n \"open_rate\": 0,\n \"click_rate\": 0,\n \"reply_rate\": 0,\n \"spam_block_rate\": 0,\n \"opt_out_rate\": 0,\n \"demo_rate\": 0,\n \"loaded_stats\": true,\n \"cc_emails\": \"\",\n \"bcc_emails\": \"\",\n \"underperforming_touches_count\": 0,\n \"sharing_permission\": {\n \"visibility\": \"everyone\",\n \"access_type\": \"can_view\",\n \"object_type\": \"EmailerCampaign\",\n \"object_id\": \"66e9e215ece19801b219997f\",\n \"is_owner\": true,\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"sharing_accesses\": []\n }\n }\n ],\n \"num_fetch_result\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d28ac7d4-bb59-4d4a-aca5-78d98c947259", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q_name", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39748832-70da-4657-9624-f351a555b461", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q_name", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/search. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cbe66fe-d7b2-4043-83e6-b7f2a37c0572", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q_name", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36b656ac-5aad-4d44-accb-5b1468d0b6d9", "name": "Add Contacts to a Sequence", "request": { "name": "Add Contacts to a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/add_contact_ids` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_add_contact_ids`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences 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 People Enrichment endpoint. Then, to add the person as a contact in your database, call the Create a Contact endpoint.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "emailer_campaign_id", "value": "", "description": "(Required) The same ID as the `sequence_id`.

Example: `66e9e215ece19801b219997f`" }, { "disabled": false, "key": "contact_ids[]", "value": "", "description": "The Apollo IDs for the contacts that you want to add to the sequence.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`

Note: Either `contact_ids[]` or `label_names[]` must be provided." }, { "disabled": false, "key": "contact_ids[]", "value": "", "description": "The Apollo IDs for the contacts that you want to add to the sequence.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`

Note: Either `contact_ids[]` or `label_names[]` must be provided." }, { "disabled": false, "key": "label_names[]", "value": "", "description": "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." }, { "disabled": false, "key": "label_names[]", "value": "", "description": "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." }, { "disabled": false, "key": "send_email_from_email_account_id", "value": "", "description": "(Required) 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 Get a List of Email Accounts endpoint and identify the `id` value for each email account.

Examples: `6633baaece5fbd01c791d7ca` (string) or `[\"6633baaece5fbd01c791d7ca\", \"6633baaece5fbd01c791d7cb\"]` (array)." }, { "disabled": false, "key": "send_email_from_email_address", "value": "", "description": "Optional specific email address to send from within the email account." }, { "disabled": false, "key": "sequence_no_email", "value": "false", "description": "Set to `true` if you want to add contacts to the sequence even if they do not have an email address." }, { "disabled": false, "key": "sequence_unverified_email", "value": "false", "description": "Set to `true` if you want to add contacts to the sequence if they have an unverified email address." }, { "disabled": false, "key": "sequence_job_change", "value": "false", "description": "Set to `true` if you want to add contacts to the sequence even if they have recently changed jobs." }, { "disabled": false, "key": "sequence_active_in_other_campaigns", "value": "false", "description": "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." }, { "disabled": false, "key": "sequence_finished_in_other_campaigns", "value": "false", "description": "Set to `true` if you want to add contacts to the sequence if they have been marked as `finished` in another sequence." }, { "disabled": false, "key": "sequence_same_company_in_same_campaign", "value": "false", "description": "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." }, { "disabled": false, "key": "contacts_without_ownership_permission", "value": "false", "description": "Set to `true` if you want to add contacts even if you don't have ownership permission for them." }, { "disabled": false, "key": "add_if_in_queue", "value": "false", "description": "Set to `true` if you want to add contacts even if they are currently in the queue for processing." }, { "disabled": false, "key": "contact_verification_skipped", "value": "false", "description": "Set to `true` if you want to skip contact verification during the addition process." }, { "disabled": false, "key": "user_id", "value": "", "description": "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 Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`" }, { "disabled": false, "key": "status", "value": "", "description": "Initial status for added contacts. When set to `paused` along with `auto_unpause_at`, enables scheduled addition of contacts." }, { "disabled": false, "key": "auto_unpause_at", "value": "", "description": "DateTime when paused contacts should be automatically unpaused. Must be used with `status=paused`. Format: ISO 8601 datetime string." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "05165ef9-5bec-40f9-9280-743c4c24cd07", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_id", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "send_email_from_email_account_id", "value": "" }, { "key": "send_email_from_email_address", "value": "" }, { "key": "sequence_no_email", "value": "false" }, { "key": "sequence_unverified_email", "value": "false" }, { "key": "sequence_job_change", "value": "false" }, { "key": "sequence_active_in_other_campaigns", "value": "false" }, { "key": "sequence_finished_in_other_campaigns", "value": "false" }, { "key": "sequence_same_company_in_same_campaign", "value": "false" }, { "key": "contacts_without_ownership_permission", "value": "false" }, { "key": "add_if_in_queue", "value": "false" }, { "key": "contact_verification_skipped", "value": "false" }, { "key": "user_id", "value": "" }, { "key": "status", "value": "" }, { "key": "auto_unpause_at", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"contact_roles\": [],\n \"id\": \"66e34b81740c50074e3d1bd4\",\n \"first_name\": \"Fyodor\",\n \"last_name\": \"Dostoevsky\",\n \"name\": \"Fyodor Dostoevsky\",\n \"linkedin_url\": null,\n \"title\": \"Chief Writer\",\n \"contact_stage_id\": null,\n \"owner_id\": \"67b307d00957c2000d08872b\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"api\",\n \"original_source\": \"api\",\n \"organization_id\": null,\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": \"St. Petersburg, Russia\",\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-09-12T20:13:53.207Z\",\n \"emailer_campaign_ids\": [\n \"66e9e215ece19801b219997f\"\n ],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"city\": \"Saint Petersburg\",\n \"country\": \"Russia\",\n \"state\": \"Saint Petersburg\",\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": null,\n \"last_activity_date\": \"2025-03-09T20:31:17.000+00:00\",\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": \"+15555550117\",\n \"merged_crm_ids\": null,\n \"updated_at\": \"2025-05-23T13:38:25.109Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"person_deleted\": null,\n \"call_opted_out\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"fyodor.dostoevsky@apollo.io\",\n \"email_from_customer\": true,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"source_display_name\": \"Created from API\",\n \"twitter_url\": null,\n \"facebook_url\": null,\n \"contact_campaign_statuses\": [\n {\n \"id\": \"68782af181c7f0002159df25\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"send_email_from_user_id\": \"66302798d03b9601c7934ebf\",\n \"inactive_reason\": \"Sequence inactive\",\n \"status\": \"paused\",\n \"added_at\": \"2025-07-16T22:42:57.372+00:00\",\n \"added_by_user_id\": \"60affe7d6e270a00f5db6fe4\",\n \"finished_at\": null,\n \"paused_at\": null,\n \"auto_unpause_at\": null,\n \"send_email_from_email_address\": \"test.marcus.hale@apollomail.io\",\n \"send_email_from_email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"manually_set_unpause\": null,\n \"failure_reason\": null,\n \"current_step_id\": null,\n \"in_response_to_emailer_message_id\": null,\n \"cc_emails\": null,\n \"bcc_emails\": null,\n \"to_emails\": null,\n \"current_step_position\": null\n }\n ],\n \"contact_emails\": [\n {\n \"email_md5\": \"cf4604bbd3c12ca9e36e20aa0aefac29\",\n \"email_sha256\": \"b5d981918efbd5a93eb10f834643a4277034f24e3b5cabc2631440c7ade49cf8\",\n \"email_status\": \"verified\",\n \"extrapolated_email_confidence\": null,\n \"position\": 0,\n \"email\": \"fyodor.dostoevsky@apollo.io\",\n \"free_domain\": false,\n \"source\": \"User Managed\",\n \"third_party_vendor_name\": null,\n \"vendor_validation_statuses\": [],\n \"email_needs_tickling\": null,\n \"email_true_status\": \"User Managed\",\n \"email_status_unavailable_reason\": null\n }\n ],\n \"time_zone\": \"Asia/Krasnoyarsk\",\n \"show_intent\": false,\n \"phone_numbers\": [\n {\n \"raw_number\": \"555-555-0117\",\n \"sanitized_number\": \"+15555550117\",\n \"type\": \"work_direct\",\n \"position\": 0,\n \"status\": \"no_status\",\n \"dnc_status\": null,\n \"dnc_other_info\": {},\n \"dialer_flags\": null,\n \"source_name\": \"User Managed\",\n \"vendor_validation_statuses\": [],\n \"third_party_vendor_name\": null\n }\n ],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"email_domain_catchall\": false\n }\n ],\n \"skipped_contact_ids\": {\n \"66e34b81740c50074e3d1bd5\": \"contact_not_found\"\n },\n \"emailer_campaign\": {\n \"id\": \"66e9e215ece19801b219997f\",\n \"name\": \"Target Copywriting Clients in Dublin\",\n \"archived\": true,\n \"created_at\": \"2024-09-17T20:09:57.837Z\",\n \"emailer_schedule_id\": \"6095a711bd01d100a506d52a\",\n \"max_emails_per_day\": null,\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"active\": false,\n \"loaded_stats\": true\n },\n \"emailer_steps\": [\n {\n \"id\": \"66e9e232ece19801b21999a4\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 1,\n \"wait_time\": 4,\n \"type\": \"auto_email\",\n \"wait_mode\": \"hour\"\n }\n ],\n \"emailer_touches\": [\n {\n \"id\": \"66e9e232ece19801b21999a6\",\n \"emailer_step_id\": \"66e9e232ece19801b21999a4\",\n \"emailer_template_id\": \"66e9e232ece19801b21999a5\",\n \"status\": \"approved\",\n \"type\": \"new_thread\"\n }\n ],\n \"team\": {\n \"id\": \"6095a710bd01d100a506d4ac\",\n \"sequences_finder_empty\": false\n },\n \"signals_hash\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc2e9a4-af64-4d4f-9e30-147cc143cc26", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_id", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "send_email_from_email_account_id", "value": "" }, { "key": "send_email_from_email_address", "value": "" }, { "key": "sequence_no_email", "value": "false" }, { "key": "sequence_unverified_email", "value": "false" }, { "key": "sequence_job_change", "value": "false" }, { "key": "sequence_active_in_other_campaigns", "value": "false" }, { "key": "sequence_finished_in_other_campaigns", "value": "false" }, { "key": "sequence_same_company_in_same_campaign", "value": "false" }, { "key": "contacts_without_ownership_permission", "value": "false" }, { "key": "add_if_in_queue", "value": "false" }, { "key": "contact_verification_skipped", "value": "false" }, { "key": "user_id", "value": "" }, { "key": "status", "value": "" }, { "key": "auto_unpause_at", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de974157-ccc9-4dd9-be30-f1b8ab27eee8", "name": "Forbidden - Master API key required", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_id", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "send_email_from_email_account_id", "value": "" }, { "key": "send_email_from_email_address", "value": "" }, { "key": "sequence_no_email", "value": "false" }, { "key": "sequence_unverified_email", "value": "false" }, { "key": "sequence_job_change", "value": "false" }, { "key": "sequence_active_in_other_campaigns", "value": "false" }, { "key": "sequence_finished_in_other_campaigns", "value": "false" }, { "key": "sequence_same_company_in_same_campaign", "value": "false" }, { "key": "contacts_without_ownership_permission", "value": "false" }, { "key": "add_if_in_queue", "value": "false" }, { "key": "contact_verification_skipped", "value": "false" }, { "key": "user_id", "value": "" }, { "key": "status", "value": "" }, { "key": "auto_unpause_at", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"This API key is not authorized to access api/v1/emailer_campaigns/add_contact_ids. Request an API key from your administrator that includes this endpoint in its configured scope.\",\n \"error_code\": \"API_INACCESSIBLE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "700f1459-9b1d-4384-971c-57f04581cedd", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_id", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "send_email_from_email_account_id", "value": "" }, { "key": "send_email_from_email_address", "value": "" }, { "key": "sequence_no_email", "value": "false" }, { "key": "sequence_unverified_email", "value": "false" }, { "key": "sequence_job_change", "value": "false" }, { "key": "sequence_active_in_other_campaigns", "value": "false" }, { "key": "sequence_finished_in_other_campaigns", "value": "false" }, { "key": "sequence_same_company_in_same_campaign", "value": "false" }, { "key": "contacts_without_ownership_permission", "value": "false" }, { "key": "add_if_in_queue", "value": "false" }, { "key": "contact_verification_skipped", "value": "false" }, { "key": "user_id", "value": "" }, { "key": "status", "value": "" }, { "key": "auto_unpause_at", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"Please specify either contact_ids or label_names.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a9352b-359e-4f1c-903d-591da1caab82", "name": "Too Many Requests - Rate limit exceeded", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "add_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_id", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "label_names[]", "value": "" }, { "key": "send_email_from_email_account_id", "value": "" }, { "key": "send_email_from_email_address", "value": "" }, { "key": "sequence_no_email", "value": "false" }, { "key": "sequence_unverified_email", "value": "false" }, { "key": "sequence_job_change", "value": "false" }, { "key": "sequence_active_in_other_campaigns", "value": "false" }, { "key": "sequence_finished_in_other_campaigns", "value": "false" }, { "key": "sequence_same_company_in_same_campaign", "value": "false" }, { "key": "contacts_without_ownership_permission", "value": "false" }, { "key": "add_if_in_queue", "value": "false" }, { "key": "contact_verification_skipped", "value": "false" }, { "key": "user_id", "value": "" }, { "key": "status", "value": "" }, { "key": "auto_unpause_at", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/{sequence_id}/add_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "820a09a8-60d3-44a7-a997-20fc6c40d306", "name": "Update Contact Status in a Sequence", "request": { "name": "Update Contact Status in a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/remove_or_stop_contact_ids` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_remove_or_stop_contact_ids`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Update Contact Status in a Sequence endpoint to either mark contacts as having `finished` a sequence, or to remove them from a sequence entirely.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", "remove_or_stop_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "emailer_campaign_ids[]", "value": "", "description": "(Required) The Apollo IDs for the sequences that you want to update. If you add multiple sequences, you will update the status of the contacts across the chosen sequences.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" }, { "disabled": false, "key": "emailer_campaign_ids[]", "value": "", "description": "(Required) The Apollo IDs for the sequences that you want to update. If you add multiple sequences, you will update the status of the contacts across the chosen sequences.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" }, { "disabled": false, "key": "contact_ids[]", "value": "", "description": "(Required) The Apollo IDs for the contacts in the sequences. These are the contacts whose sequence status you want to update.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`" }, { "disabled": false, "key": "contact_ids[]", "value": "", "description": "(Required) The Apollo IDs for the contacts in the sequences. These are the contacts whose sequence status you want to update.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`" }, { "disabled": false, "key": "mode", "value": "", "description": "(Required) Choose 1 of the following options to update the sequence status of the contacts:
  • `mark_as_finished`: Mark the contacts as having finished the sequence.
  • `remove`: Remove the contacts from the sequence.
  • `stop`: Indicate that the contacts progress in the sequence has halted.
" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "eaef7ed2-e5be-4eeb-bbae-8cea343b5dd1", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", "remove_or_stop_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "mode", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"contact_roles\": [],\n \"id\": \"66e34b81740c50074e3d1bd4\",\n \"first_name\": \"Fyodor\",\n \"last_name\": \"Dostoevsky\",\n \"name\": \"Fyodor Dostoevsky\",\n \"linkedin_url\": null,\n \"title\": \"Chief Writer\",\n \"contact_stage_id\": null,\n \"owner_id\": \"67b307d00957c2000d08872b\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"api\",\n \"original_source\": \"api\",\n \"organization_id\": null,\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": \"St. Petersburg, Russia\",\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-09-12T20:13:53.207Z\",\n \"emailer_campaign_ids\": [\n \"66e9e215ece19801b219997f\"\n ],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"city\": \"Saint Petersburg\",\n \"country\": \"Russia\",\n \"state\": \"Saint Petersburg\",\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": null,\n \"last_activity_date\": \"2025-03-09T20:31:17.000+00:00\",\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": \"+15555550117\",\n \"merged_crm_ids\": null,\n \"updated_at\": \"2025-05-23T13:38:25.109Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"person_deleted\": null,\n \"call_opted_out\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"fyodor.dostoevsky@apollo.io\",\n \"email_from_customer\": true,\n \"custom_field_errors\": {},\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"source_display_name\": \"Created from API\",\n \"twitter_url\": null,\n \"facebook_url\": null,\n \"contact_campaign_statuses\": [\n {\n \"id\": \"68782af181c7f0002159df25\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"send_email_from_user_id\": \"66302798d03b9601c7934ebf\",\n \"inactive_reason\": \"manually finished\",\n \"status\": \"finished\",\n \"added_at\": \"2025-07-16T22:42:57.372+00:00\",\n \"added_by_user_id\": \"60affe7d6e270a00f5db6fe4\",\n \"finished_at\": \"2025-07-16T22:45:21.237+00:00\",\n \"paused_at\": null,\n \"auto_unpause_at\": null,\n \"send_email_from_email_address\": \"test.marcus.hale@apollomail.io\",\n \"send_email_from_email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"manually_set_unpause\": null,\n \"failure_reason\": null,\n \"current_step_id\": null,\n \"in_response_to_emailer_message_id\": null,\n \"cc_emails\": null,\n \"bcc_emails\": null,\n \"to_emails\": null,\n \"current_step_position\": null\n }\n ],\n \"contact_emails\": [\n {\n \"email_md5\": \"cf4604bbd3c12ca9e36e20aa0aefac29\",\n \"email_sha256\": \"b5d981918efbd5a93eb10f834643a4277034f24e3b5cabc2631440c7ade49cf8\",\n \"email_status\": \"verified\",\n \"extrapolated_email_confidence\": null,\n \"position\": 0,\n \"email\": \"fyodor.dostoevsky@apollo.io\",\n \"free_domain\": false,\n \"source\": \"User Managed\",\n \"third_party_vendor_name\": null,\n \"vendor_validation_statuses\": [],\n \"email_needs_tickling\": null,\n \"email_true_status\": \"User Managed\",\n \"email_status_unavailable_reason\": null\n }\n ],\n \"time_zone\": \"Asia/Krasnoyarsk\",\n \"show_intent\": false,\n \"phone_numbers\": [\n {\n \"raw_number\": \"555-555-0117\",\n \"sanitized_number\": \"+15555550117\",\n \"type\": \"work_direct\",\n \"position\": 0,\n \"status\": \"no_status\",\n \"dnc_status\": null,\n \"dnc_other_info\": {},\n \"dialer_flags\": null,\n \"source_name\": \"User Managed\",\n \"vendor_validation_statuses\": [],\n \"third_party_vendor_name\": null\n }\n ],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"email_domain_catchall\": false,\n \"typed_custom_fields\": {\n \"5b75f1c11dc2727d43ae3bb9\": \"test\",\n \"5c4296857f799409361890ea\": \"test2\"\n }\n }\n ],\n \"emailer_campaigns\": [\n {\n \"id\": \"66e9e215ece19801b219997f\"\n }\n ],\n \"num_contacts\": 3,\n \"contact_statuses\": {\n \"active\": \"loading\",\n \"failed\": 0,\n \"paused\": \"loading\",\n \"finished\": \"loading\",\n \"bounced\": \"loading\",\n \"hard_bounced\": \"loading\",\n \"spam_blocked\": \"loading\",\n \"not_sent\": \"loading\"\n },\n \"emailer_steps\": [\n {\n \"id\": \"66e9e232ece19801b21999a4\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 1,\n \"wait_time\": 4,\n \"type\": \"auto_email\",\n \"wait_mode\": \"hour\",\n \"note\": null,\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"priority\": null,\n \"auto_skip_in_x_days\": null,\n \"counts\": {\n \"active\": 0,\n \"paused\": 0,\n \"finished\": 4,\n \"bounced\": 0,\n \"spam_blocked\": 0,\n \"hard_bounced\": 0,\n \"not_sent\": 0\n },\n \"ab_test_details\": {}\n },\n {\n \"id\": \"66e9e250ece19802d1196d07\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 2,\n \"wait_time\": 3,\n \"type\": \"call\",\n \"wait_mode\": \"day\",\n \"note\": \"\",\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"priority\": \"high\",\n \"auto_skip_in_x_days\": null,\n \"counts\": {\n \"active\": 0,\n \"paused\": 0,\n \"finished\": 0,\n \"bounced\": 0,\n \"spam_blocked\": 0,\n \"hard_bounced\": 0,\n \"not_sent\": 0\n },\n \"ab_test_details\": {},\n \"note_text\": \"\",\n \"unique_scheduled\": \"loading\",\n \"unique_skipped\": \"loading\",\n \"unique_completed\": \"loading\",\n \"outcomes\": []\n },\n {\n \"id\": \"66e9e265ece198053919497b\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 3,\n \"wait_time\": 3,\n \"type\": \"action_item\",\n \"wait_mode\": \"day\",\n \"note\": \"Decide the next step to take for contacts in the sequence.\",\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"priority\": \"medium\",\n \"auto_skip_in_x_days\": null,\n \"counts\": {\n \"active\": 0,\n \"paused\": 0,\n \"finished\": 0,\n \"bounced\": 0,\n \"spam_blocked\": 0,\n \"hard_bounced\": 0,\n \"not_sent\": 0\n },\n \"ab_test_details\": {},\n \"unique_scheduled\": \"loading\",\n \"unique_skipped\": \"loading\",\n \"unique_completed\": \"loading\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d55c5b73-1a8c-49af-97d0-8b16fad77f94", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", "remove_or_stop_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "mode", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a922fa4-cb15-4075-aaf9-3924e6b95772", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", "remove_or_stop_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "mode", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/remove_or_stop_contact_ids. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b5d1ddb-067b-44b7-8d61-932e0138af99", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", "remove_or_stop_contact_ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "contact_ids[]", "value": "" }, { "key": "mode", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/remove_or_stop_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9ca56e4-586c-4a30-8c35-fcac45fef3bf", "name": "Create a Sequence", "request": { "name": "Create a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/sequences/create` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_create`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences 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.\n\n### Who owns a sequence created via API\n\nThe 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](https://docs.apollo.io/reference/authentication) for how the acting user is resolved and how to confirm it.\n\nThis 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](https://docs.apollo.io/reference/update-sequence) with a `user_id`.", "type": "text/plain" }, "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"permissions\": \"\",\n \"active\": \"\",\n \"emailer_schedule_id\": \"\",\n \"user_id\": \"\",\n \"label_names\": [\n \"\",\n \"\"\n ],\n \"folder_id\": \"\",\n \"sequence_by_exact_daytime\": \"\",\n \"max_emails_per_day\": \"\",\n \"mark_finished_if_reply\": \"\",\n \"mark_finished_if_click\": \"\",\n \"mark_finished_if_interested\": \"\",\n \"mark_paused_if_ooo\": \"\",\n \"days_to_wait_before_mark_as_response\": \"\",\n \"create_task_if_email_open\": \"\",\n \"email_open_trigger_task_threshold\": \"\",\n \"same_account_reply_delay_days\": \"\",\n \"excluded_account_stage_ids\": [\n \"\",\n \"\"\n ],\n \"excluded_contact_stage_ids\": [\n \"\",\n \"\"\n ],\n \"ignore_apollo_global_email_bounce_list\": \"\",\n \"sequence_ruleset_id\": \"\",\n \"emailer_steps\": [\n {\n \"type\": \"\",\n \"wait_time\": \"\",\n \"wait_mode\": \"\",\n \"exact_datetime\": \"\",\n \"priority\": \"\",\n \"note\": \"\",\n \"max_emails_per_day\": \"\",\n \"auto_skip_in_x_days\": \"\",\n \"emailer_touches\": [\n {\n \"type\": \"\",\n \"status\": \"\",\n \"include_signature\": \"\",\n \"emailer_template\": {\n \"id\": \"\",\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"\",\n \"status\": \"\",\n \"include_signature\": \"\",\n \"emailer_template\": {\n \"id\": \"\",\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"\",\n \"wait_time\": \"\",\n \"wait_mode\": \"\",\n \"exact_datetime\": \"\",\n \"priority\": \"\",\n \"note\": \"\",\n \"max_emails_per_day\": \"\",\n \"auto_skip_in_x_days\": \"\",\n \"emailer_touches\": [\n {\n \"type\": \"\",\n \"status\": \"\",\n \"include_signature\": \"\",\n \"emailer_template\": {\n \"id\": \"\",\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"\",\n \"status\": \"\",\n \"include_signature\": \"\",\n \"emailer_template\": {\n \"id\": \"\",\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "137250a9-0826-474f-b789-32691664acb9", "name": "200", "originalRequest": { "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach\",\n \"active\": true,\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"label_names\": [\n \"Outbound\"\n ],\n \"emailer_steps\": [\n {\n \"type\": \"auto_email\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"emailer_touches\": [\n {\n \"type\": \"new_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"Quick question, {{first_name}}\",\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\"\n }\n }\n ]\n },\n {\n \"type\": \"auto_email\",\n \"wait_time\": 3,\n \"wait_mode\": \"day\",\n \"emailer_touches\": [\n {\n \"type\": \"reply_to_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emailer_campaign\": {\n \"id\": \"68b1f3a2e1d2c40001a23b45\",\n \"name\": \"Q3 Outbound Outreach\",\n \"description\": null,\n \"archived\": false,\n \"created_at\": \"2026-06-12T10:15:30.000Z\",\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"max_emails_per_day\": null,\n \"user_id\": \"60affe7d6e270a00f5db6fe4\",\n \"same_account_reply_policy_cd\": null,\n \"excluded_account_stage_ids\": [],\n \"excluded_contact_stage_ids\": [],\n \"contact_email_event_to_stage_mapping\": {},\n \"label_ids\": [\n \"68b1f3a3e1d2c40001a23b50\"\n ],\n \"create_task_if_email_open\": null,\n \"email_open_trigger_task_threshold\": null,\n \"mark_finished_if_click\": null,\n \"active\": true,\n \"days_to_wait_before_mark_as_response\": null,\n \"starred_by_user_ids\": [],\n \"mark_finished_if_reply\": null,\n \"mark_finished_if_interested\": null,\n \"mark_paused_if_ooo\": null,\n \"sequence_by_exact_daytime\": null,\n \"last_used_at\": null,\n \"sequence_ruleset_id\": null,\n \"ignore_apollo_global_email_bounce_list\": null,\n \"folder_id\": null,\n \"same_account_reply_delay_days\": null,\n \"is_performing_poorly\": false,\n \"num_contacts_email_status_extrapolated\": null,\n \"remind_ab_test_results\": null,\n \"ab_test_step_ids\": [],\n \"prioritized_by_user\": null,\n \"creation_type\": \"new\",\n \"object_owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"dmp_ids\": [],\n \"content_center_type\": null,\n \"product_profile_ids\": [],\n \"status_reason\": \"manual_approve\",\n \"auto_pause_warning_level\": null,\n \"auto_paused_at\": null,\n \"auto_pause_bounce_rate\": null,\n \"allowed_send_from_domains\": [],\n \"project_workspace_context\": {},\n \"num_steps\": 2,\n \"unique_scheduled\": \"loading\",\n \"unique_delivered\": \"loading\",\n \"unique_bounced\": \"loading\",\n \"unique_opened\": \"loading\",\n \"unique_hard_bounced\": \"loading\",\n \"unique_spam_blocked\": \"loading\",\n \"unique_replied\": \"loading\",\n \"unique_demoed\": \"loading\",\n \"unique_clicked\": \"loading\",\n \"unique_unsubscribed\": \"loading\",\n \"unique_opened_unfiltered\": \"loading\",\n \"unique_clicked_unfiltered\": \"loading\",\n \"unique_delivered_open_tracked\": \"loading\",\n \"unique_delivered_click_tracked\": \"loading\",\n \"bounce_rate\": \"loading\",\n \"open_rate\": \"loading\",\n \"click_rate\": \"loading\",\n \"reply_rate\": \"loading\",\n \"spam_block_rate\": \"loading\",\n \"opt_out_rate\": \"loading\",\n \"demo_rate\": \"loading\",\n \"loaded_stats\": true,\n \"contact_statuses\": {\n \"active\": 0,\n \"failed\": 0,\n \"paused\": 0,\n \"finished\": 0,\n \"bounced\": 0,\n \"hard_bounced\": 0,\n \"spam_blocked\": 0,\n \"not_sent\": 0\n },\n \"cc_emails\": \"\",\n \"bcc_emails\": \"\",\n \"underperforming_touches_count\": 0,\n \"sharing_permission\": {\n \"visibility\": \"restricted\",\n \"access_type\": null,\n \"object_type\": \"EmailerCampaign\",\n \"object_id\": \"68b1f3a2e1d2c40001a23b45\",\n \"is_owner\": true,\n \"owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"sharing_accesses\": []\n },\n \"auto_pause_enabled\": false,\n \"auto_pause_config\": {\n \"evaluation_window_days\": 7,\n \"min_volume\": 200,\n \"warning_threshold_pct\": 7,\n \"auto_pause_threshold_pct\": 10\n }\n },\n \"sharing_accesses\": [],\n \"emailer_steps\": [\n {\n \"id\": \"68b1f3a2e1d2c40001a23b46\",\n \"emailer_campaign_id\": \"68b1f3a2e1d2c40001a23b45\",\n \"position\": 1,\n \"wait_time\": 0,\n \"type\": \"auto_email\",\n \"wait_mode\": \"minute\",\n \"note\": null,\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"priority\": null,\n \"auto_skip_in_x_days\": null,\n \"counts\": {\n \"active\": 0,\n \"paused\": 0,\n \"finished\": 0,\n \"bounced\": 0,\n \"spam_blocked\": 0,\n \"hard_bounced\": 0,\n \"not_sent\": 0\n },\n \"ab_test_details\": {}\n },\n {\n \"id\": \"68b1f3a2e1d2c40001a23b47\",\n \"emailer_campaign_id\": \"68b1f3a2e1d2c40001a23b45\",\n \"position\": 2,\n \"wait_time\": 3,\n \"type\": \"auto_email\",\n \"wait_mode\": \"day\",\n \"note\": null,\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"priority\": null,\n \"auto_skip_in_x_days\": null,\n \"counts\": {\n \"active\": 0,\n \"paused\": 0,\n \"finished\": 0,\n \"bounced\": 0,\n \"spam_blocked\": 0,\n \"hard_bounced\": 0,\n \"not_sent\": 0\n },\n \"ab_test_details\": {}\n }\n ],\n \"emailer_touches\": [\n {\n \"id\": \"68b1f3a2e1d2c40001a23b48\",\n \"emailer_step_id\": \"68b1f3a2e1d2c40001a23b46\",\n \"emailer_template_id\": \"68b1f3a2e1d2c40001a23b4a\",\n \"status\": \"approved\",\n \"type\": \"new_thread\",\n \"include_signature\": true,\n \"has_personalized_opener\": null,\n \"personalized_opener_fallback_option\": \"send_without_opener\",\n \"generic_personalized_opener\": null,\n \"template_type\": null,\n \"generation_options\": [],\n \"generation_tone\": {},\n \"content_center_type\": null,\n \"product_profile_ids\": [],\n \"composition_mode\": null,\n \"project_workspace_id\": null,\n \"unique_scheduled\": \"loading\",\n \"unique_delivered\": \"loading\",\n \"unique_delivered_open_tracked\": \"loading\",\n \"unique_delivered_click_tracked\": \"loading\",\n \"unique_bounced\": \"loading\",\n \"unique_hard_bounced\": \"loading\",\n \"unique_spam_blocked\": \"loading\",\n \"unique_opened\": \"loading\",\n \"unique_opened_unfiltered\": \"loading\",\n \"unique_clicked\": \"loading\",\n \"unique_clicked_unfiltered\": \"loading\",\n \"unique_replied\": \"loading\",\n \"unique_demoed\": \"loading\",\n \"unique_unsubscribed\": \"loading\",\n \"bounce_rate\": \"loading\",\n \"hard_bounce_rate\": \"loading\",\n \"spam_block_rate\": \"loading\",\n \"open_rate\": \"loading\",\n \"open_rate_unfiltered\": \"loading\",\n \"open_rate_tracked\": \"loading\",\n \"open_rate_unfiltered_tracked\": \"loading\",\n \"click_rate\": \"loading\",\n \"click_rate_unfiltered\": \"loading\",\n \"click_rate_tracked\": \"loading\",\n \"click_rate_unfiltered_tracked\": \"loading\",\n \"reply_rate\": \"loading\",\n \"demo_rate\": \"loading\",\n \"opt_out_rate\": \"loading\"\n },\n {\n \"id\": \"68b1f3a2e1d2c40001a23b49\",\n \"emailer_step_id\": \"68b1f3a2e1d2c40001a23b47\",\n \"emailer_template_id\": \"68b1f3a2e1d2c40001a23b4b\",\n \"status\": \"approved\",\n \"type\": \"reply_to_thread\",\n \"include_signature\": true,\n \"has_personalized_opener\": null,\n \"personalized_opener_fallback_option\": \"send_without_opener\",\n \"generic_personalized_opener\": null,\n \"template_type\": null,\n \"generation_options\": [],\n \"generation_tone\": {},\n \"content_center_type\": null,\n \"product_profile_ids\": [],\n \"composition_mode\": null,\n \"project_workspace_id\": null,\n \"unique_scheduled\": \"loading\",\n \"unique_delivered\": \"loading\",\n \"unique_delivered_open_tracked\": \"loading\",\n \"unique_delivered_click_tracked\": \"loading\",\n \"unique_bounced\": \"loading\",\n \"unique_hard_bounced\": \"loading\",\n \"unique_spam_blocked\": \"loading\",\n \"unique_opened\": \"loading\",\n \"unique_opened_unfiltered\": \"loading\",\n \"unique_clicked\": \"loading\",\n \"unique_clicked_unfiltered\": \"loading\",\n \"unique_replied\": \"loading\",\n \"unique_demoed\": \"loading\",\n \"unique_unsubscribed\": \"loading\",\n \"bounce_rate\": \"loading\",\n \"hard_bounce_rate\": \"loading\",\n \"spam_block_rate\": \"loading\",\n \"open_rate\": \"loading\",\n \"open_rate_unfiltered\": \"loading\",\n \"open_rate_tracked\": \"loading\",\n \"open_rate_unfiltered_tracked\": \"loading\",\n \"click_rate\": \"loading\",\n \"click_rate_unfiltered\": \"loading\",\n \"click_rate_tracked\": \"loading\",\n \"click_rate_unfiltered_tracked\": \"loading\",\n \"reply_rate\": \"loading\",\n \"demo_rate\": \"loading\",\n \"opt_out_rate\": \"loading\"\n }\n ],\n \"emailer_templates\": [\n {\n \"id\": \"68b1f3a2e1d2c40001a23b4a\",\n \"name\": null,\n \"user_id\": \"60affe7d6e270a00f5db6fe4\",\n \"starred_by_user_ids\": [],\n \"subject\": \"Quick question, {{first_name}}\",\n \"archived\": null,\n \"created_at\": \"2026-06-12T10:15:30.000Z\",\n \"global\": false,\n \"body_text\": null,\n \"folder_id\": null,\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\",\n \"creation_type\": null,\n \"prompt_template_id\": null,\n \"description\": null,\n \"highlights\": null,\n \"has_ai_variables\": false,\n \"label_ids\": [],\n \"prompt_id\": null\n },\n {\n \"id\": \"68b1f3a2e1d2c40001a23b4b\",\n \"name\": null,\n \"user_id\": \"60affe7d6e270a00f5db6fe4\",\n \"starred_by_user_ids\": [],\n \"subject\": \"\",\n \"archived\": null,\n \"created_at\": \"2026-06-12T10:15:30.000Z\",\n \"global\": false,\n \"body_text\": null,\n \"folder_id\": null,\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\",\n \"creation_type\": null,\n \"prompt_template_id\": null,\n \"description\": null,\n \"highlights\": null,\n \"has_ai_variables\": false,\n \"label_ids\": [],\n \"prompt_id\": null\n }\n ],\n \"attachments\": [],\n \"team\": {\n \"id\": \"5f2f4b5e9c1d4e0001b6c7d8\",\n \"sequences_finder_empty\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f66b394e-de21-48de-abd2-ffb255a16ebd", "name": "401", "originalRequest": { "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach\",\n \"active\": true,\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"label_names\": [\n \"Outbound\"\n ],\n \"emailer_steps\": [\n {\n \"type\": \"auto_email\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"emailer_touches\": [\n {\n \"type\": \"new_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"Quick question, {{first_name}}\",\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\"\n }\n }\n ]\n },\n {\n \"type\": \"auto_email\",\n \"wait_time\": 3,\n \"wait_mode\": \"day\",\n \"emailer_touches\": [\n {\n \"type\": \"reply_to_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b4afdca-3051-464e-b033-6b84e1ed90c3", "name": "403", "originalRequest": { "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach\",\n \"active\": true,\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"label_names\": [\n \"Outbound\"\n ],\n \"emailer_steps\": [\n {\n \"type\": \"auto_email\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"emailer_touches\": [\n {\n \"type\": \"new_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"Quick question, {{first_name}}\",\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\"\n }\n }\n ]\n },\n {\n \"type\": \"auto_email\",\n \"wait_time\": 3,\n \"wait_mode\": \"day\",\n \"emailer_touches\": [\n {\n \"type\": \"reply_to_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/sequences/create. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40a0ebd3-0215-4c09-80e1-24ff4a940011", "name": "422", "originalRequest": { "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach\",\n \"active\": true,\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"label_names\": [\n \"Outbound\"\n ],\n \"emailer_steps\": [\n {\n \"type\": \"auto_email\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"emailer_touches\": [\n {\n \"type\": \"new_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"Quick question, {{first_name}}\",\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\"\n }\n }\n ]\n },\n {\n \"type\": \"auto_email\",\n \"wait_time\": 3,\n \"wait_mode\": \"day\",\n \"emailer_touches\": [\n {\n \"type\": \"reply_to_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"You do not have the permission to create sequences.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bc52c22-351d-42f1-953b-36e690e65c51", "name": "429", "originalRequest": { "url": { "path": [ "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach\",\n \"active\": true,\n \"emailer_schedule_id\": \"66e9e215ece19801b2199900\",\n \"label_names\": [\n \"Outbound\"\n ],\n \"emailer_steps\": [\n {\n \"type\": \"auto_email\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"emailer_touches\": [\n {\n \"type\": \"new_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"Quick question, {{first_name}}\",\n \"body_html\": \"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

\"\n }\n }\n ]\n },\n {\n \"type\": \"auto_email\",\n \"wait_time\": 3,\n \"wait_mode\": \"day\",\n \"emailer_touches\": [\n {\n \"type\": \"reply_to_thread\",\n \"status\": \"approved\",\n \"include_signature\": true,\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"

Hi {{first_name}}, just floating this back to the top of your inbox.

\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"We are already processing the request for your sequence\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b432347c-3524-40bb-953f-b95f9d177e76", "name": "Update a Sequence", "request": { "name": "Update a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/sequences/update` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Update a Sequence endpoint to update an existing sequence (emailer campaign) in your team's Apollo account.

You can update sequence-level settings, such as the name, active state, schedule, and sending limits, as well as the sequence's steps and the email touches within each step.

To turn a sequence on or off, set the `active` field. Passing `emailer_steps` will create, update, reorder, or remove steps and their touches based on the IDs you provide.

To create a new sequence instead, use the Create a Sequence endpoint.\n\n### Reassigning sequence ownership\n\nUnlike [Create a Sequence](https://docs.apollo.io/reference/create-sequence), this endpoint accepts `user_id` and uses it to change who owns the sequence. Pass the intended owner's Apollo user ID, and the response reflects it in both `user_id` and its alias `object_owner_id`. Use [Get a List of Users](https://docs.apollo.io/reference/get-a-list-of-users) to look up IDs.\n\nThis is how you correct ownership on sequences created with an API key, which aren't owned by the teammate who created the key. See [Authentication](https://docs.apollo.io/reference/authentication) for how the acting user is resolved.", "type": "text/plain" }, "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"creation_type\": \"\",\n \"permissions\": \"\",\n \"sharing_permission\": {\n \"visibility\": \"\",\n \"access_type\": \"\",\n \"added_sharing_accesses\": [\n {\n \"user_or_team_id\": \"\",\n \"user_or_team_type\": \"\",\n \"access_type\": \"\"\n },\n {\n \"user_or_team_id\": \"\",\n \"user_or_team_type\": \"\",\n \"access_type\": \"\"\n }\n ],\n \"updated_sharing_accesses\": [\n {\n \"user_or_team_id\": \"\",\n \"access_type\": \"\"\n },\n {\n \"user_or_team_id\": \"\",\n \"access_type\": \"\"\n }\n ],\n \"deleted_sharing_accesses\": [\n {\n \"user_or_team_id\": \"\"\n },\n {\n \"user_or_team_id\": \"\"\n }\n ]\n },\n \"user_id\": \"\",\n \"emailer_schedule_id\": \"\",\n \"label_names\": [\n \"\",\n \"\"\n ],\n \"max_emails_per_day\": \"\",\n \"same_account_reply_delay_days\": \"\",\n \"cc_emails\": \"\",\n \"bcc_emails\": \"\",\n \"emailer_steps\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"type\": \"\",\n \"wait_mode\": \"\",\n \"wait_time\": \"\",\n \"auto_skip_in_x_days\": \"\",\n \"emailer_touches\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"attachment_ids\": [\n \"\",\n \"\"\n ],\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"generation_options\": [\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n },\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n }\n ],\n \"generation_tone\": {\n \"tone_type\": \"\",\n \"tone_sample\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"attachment_ids\": [\n \"\",\n \"\"\n ],\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"generation_options\": [\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n },\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n }\n ],\n \"generation_tone\": {\n \"tone_type\": \"\",\n \"tone_sample\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"type\": \"\",\n \"wait_mode\": \"\",\n \"wait_time\": \"\",\n \"auto_skip_in_x_days\": \"\",\n \"emailer_touches\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"attachment_ids\": [\n \"\",\n \"\"\n ],\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"generation_options\": [\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n },\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n }\n ],\n \"generation_tone\": {\n \"tone_type\": \"\",\n \"tone_sample\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"attachment_ids\": [\n \"\",\n \"\"\n ],\n \"emailer_template\": {\n \"subject\": \"\",\n \"body_html\": \"\"\n },\n \"generation_options\": [\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n },\n {\n \"type\": \"\",\n \"additional_prompt\": \"\",\n \"signals\": [\n \"\",\n \"\"\n ],\n \"field_name\": \"\"\n }\n ],\n \"generation_tone\": {\n \"tone_type\": \"\",\n \"tone_sample\": \"\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a2d66ad7-9a93-4eb8-ae87-6028f62f38ff", "name": "200", "originalRequest": { "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach (revised)\",\n \"max_emails_per_day\": 50\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"66e34b81740c50074e3d1bd4\",\n \"name\": \"first campaign\",\n \"active\": true,\n \"archived\": false,\n \"created_at\": \"2024-09-12T20:13:53.207Z\",\n \"updated_at\": \"2024-09-12T20:14:53.134Z\",\n \"num_steps\": 1,\n \"steps\": [\n {\n \"id\": \"66e361494acd1307386d4073\",\n \"position\": 1,\n \"step_type\": \"auto_email\",\n \"wait_time\": 1,\n \"wait_mode\": \"day\",\n \"auto_skip_in_x_days\": null\n }\n ],\n \"emailer_campaign\": {\n \"id\": \"66e34b81740c50074e3d1bd4\",\n \"name\": \"first campaign\",\n \"active\": true\n },\n \"emailer_steps\": [\n {\n \"id\": \"66e361494acd1307386d4073\",\n \"position\": 1\n }\n ],\n \"emailer_touches\": [\n {\n \"id\": \"66e361494acd1307386d4074\",\n \"status\": \"approved\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec8b0d1e-c291-4b37-af52-f2c8a931107f", "name": "401", "originalRequest": { "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach (revised)\",\n \"max_emails_per_day\": 50\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "483a9044-6035-4063-b1b5-3f5d12f524d5", "name": "404", "originalRequest": { "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach (revised)\",\n \"max_emails_per_day\": 50\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Record not found.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "250adf75-5074-4896-b7f1-041f4514b61c", "name": "422", "originalRequest": { "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach (revised)\",\n \"max_emails_per_day\": 50\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Please make sure your template has a non-empty body before turning it on.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec0e13f4-8275-4835-b0b7-819ee84ecb94", "name": "429", "originalRequest": { "url": { "path": [ "sequences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q3 Outbound Outreach (revised)\",\n \"max_emails_per_day\": 50\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"We are already processing the request for your sequence\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "909fbabd-df1b-4c7b-adf4-cb00f93953cd", "name": "Check Email Stats", "request": { "name": "Check Email Stats", "description": { "content": "## Endpoint essentials\n\n**API key access:** `Master API key`\n\n**OAuth scopes:** `Not supported`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Check Email Stats endpoint to review the complete details for an email sent as part of an Apollo sequence. This includes the contents of the emails, stats related to the email such as opens and clicks, and details about the contact that received the email.", "type": "text/plain" }, "url": { "path": [ "emailer_messages", ":id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "df76dff5-3acf-47a8-b4f8-93c3867ff5e3", "name": "OK", "originalRequest": { "url": { "path": [ "emailer_messages", ":id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"activities\\\": [\\n {\\n \\\"id\\\": \\\"684b2203a2ce950021cbf730\\\",\\n \\\"type\\\": \\\"emailer_message\\\",\\n \\\"emailer_message_id\\\": \\\"684b2203a2ce950021cbf730\\\",\\n \\\"emailer_message\\\": {\\n \\\"id\\\": \\\"684b2203a2ce950021cbf730\\\",\\n \\\"user_id\\\": \\\"66302798d03b9601c7934ebf\\\",\\n \\\"status\\\": \\\"completed\\\",\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"provider_message_id\\\": \\\"1976610a368f41f9\\\",\\n \\\"to_name\\\": \\\"Gina Larkin\\\",\\n \\\"due_at\\\": \\\"2025-06-12T21:32:10.580+00:00\\\",\\n \\\"completed_at\\\": \\\"2025-06-12T21:34:16.411+00:00\\\",\\n \\\"emailer_touch_id\\\": \\\"684b216ec95a4f001d968d1b\\\",\\n \\\"emailer_campaign_id\\\": \\\"684b215edf80730019db612c\\\",\\n \\\"emailer_step_id\\\": \\\"684b216ec95a4f001d968d19\\\",\\n \\\"failed_at\\\": \\\"2025-06-12T19:04:06.820+00:00\\\",\\n \\\"failure_reason\\\": \\\"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\\\",\\n \\\"attachment_ids\\\": [],\\n \\\"enable_tracking\\\": true,\\n \\\"type\\\": \\\"outreach_automatic_email\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"provider_thread_id\\\": \\\"197660da712c817b\\\",\\n \\\"schedule_delayed_reason\\\": null,\\n \\\"demoed\\\": null,\\n \\\"email_account_id\\\": \\\"6633baaece5fbd01c791d7ca\\\",\\n \\\"due_at_manually_changed\\\": true,\\n \\\"not_sent_reason\\\": \\\"account_stage_safeguard\\\",\\n \\\"bounce\\\": false,\\n \\\"spam_blocked\\\": false,\\n \\\"tracking_disabled_reason\\\": null,\\n \\\"created_at\\\": \\\"2025-06-12T18:52:51.021Z\\\",\\n \\\"async_sending\\\": false,\\n \\\"due_at_source\\\": \\\"Email was sent using Send Now action\\\",\\n \\\"crm_id\\\": null,\\n \\\"replied\\\": null,\\n \\\"needs_dynamic_assemble\\\": false,\\n \\\"personalized_opener\\\": null,\\n \\\"reply_class\\\": null,\\n \\\"schedule_delayed_limit_reason\\\": null,\\n \\\"schedule_delayed_reason_details\\\": null,\\n \\\"sensitive_info_redacted\\\": null,\\n \\\"account_id\\\": \\\"6518c6184f20350001a0b9c0\\\",\\n \\\"recipients\\\": [\\n {\\n \\\"email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"raw_name\\\": \\\"Gina Larkin\\\",\\n \\\"recipient_type_cd\\\": \\\"to\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"user_id\\\": null\\n }\\n ],\\n \\\"send_from\\\": {\\n \\\"email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"raw_name\\\": \\\"David Smith\\\",\\n \\\"recipient_type_cd\\\": null,\\n \\\"contact_id\\\": null,\\n \\\"user_id\\\": null\\n },\\n \\\"from_email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"to_email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"from_name\\\": \\\"David Smith\\\",\\n \\\"bcc_emails\\\": [],\\n \\\"cc_emails\\\": [],\\n \\\"send_from_info\\\": \\\"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\\\",\\n \\\"body_text\\\": \\\"Check out my email now!\\\\nDavid SmithApollo Knowledge Base \\\",\\n \\\"body_html\\\": \\\"
\\\\n
Check out my email now!
\\\\n
David Smith
\\\\n\\\\n
\\\\n
\\\",\\n \\\"body_html_loaded\\\": true,\\n \\\"appendment_html\\\": \\\"\\\",\\n \\\"appendment_html_loaded\\\": true,\\n \\\"subject\\\": \\\"Stats for you\\\",\\n \\\"emailer_message_events\\\": [],\\n \\\"num_opens\\\": 0,\\n \\\"num_clicks\\\": 0,\\n \\\"campaign_name\\\": \\\"Stats Sequences DO NOT USE\\\",\\n \\\"campaign_max_emails_per_day\\\": null,\\n \\\"campaign_position\\\": 1,\\n \\\"step_max_emails_per_day\\\": null\\n }\\n }\\n ],\\n \\\"emailer_message\\\": {\\n \\\"id\\\": \\\"684b2203a2ce950021cbf730\\\",\\n \\\"user_id\\\": \\\"66302798d03b9601c7934ebf\\\",\\n \\\"status\\\": \\\"completed\\\",\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"provider_message_id\\\": \\\"1976610a368f41f9\\\",\\n \\\"to_name\\\": \\\"Gina Larkin\\\",\\n \\\"due_at\\\": \\\"2025-06-12T21:32:10.580+00:00\\\",\\n \\\"completed_at\\\": \\\"2025-06-12T21:34:16.411+00:00\\\",\\n \\\"emailer_touch_id\\\": \\\"684b216ec95a4f001d968d1b\\\",\\n \\\"emailer_campaign_id\\\": \\\"684b215edf80730019db612c\\\",\\n \\\"emailer_step_id\\\": \\\"684b216ec95a4f001d968d19\\\",\\n \\\"failed_at\\\": \\\"2025-06-12T19:04:06.820+00:00\\\",\\n \\\"failure_reason\\\": \\\"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\\\",\\n \\\"attachment_ids\\\": [],\\n \\\"enable_tracking\\\": true,\\n \\\"type\\\": \\\"outreach_automatic_email\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"provider_thread_id\\\": \\\"197660da712c817b\\\",\\n \\\"schedule_delayed_reason\\\": null,\\n \\\"demoed\\\": null,\\n \\\"email_account_id\\\": \\\"6633baaece5fbd01c791d7ca\\\",\\n \\\"due_at_manually_changed\\\": true,\\n \\\"not_sent_reason\\\": \\\"account_stage_safeguard\\\",\\n \\\"bounce\\\": false,\\n \\\"spam_blocked\\\": false,\\n \\\"tracking_disabled_reason\\\": null,\\n \\\"created_at\\\": \\\"2025-06-12T18:52:51.021Z\\\",\\n \\\"async_sending\\\": false,\\n \\\"due_at_source\\\": \\\"Email was sent using Send Now action\\\",\\n \\\"crm_id\\\": null,\\n \\\"replied\\\": null,\\n \\\"needs_dynamic_assemble\\\": false,\\n \\\"personalized_opener\\\": null,\\n \\\"reply_class\\\": null,\\n \\\"schedule_delayed_limit_reason\\\": null,\\n \\\"schedule_delayed_reason_details\\\": null,\\n \\\"sensitive_info_redacted\\\": null,\\n \\\"account_id\\\": \\\"6518c6184f20350001a0b9c0\\\",\\n \\\"recipients\\\": [\\n {\\n \\\"email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"raw_name\\\": \\\"Gina Larkin\\\",\\n \\\"recipient_type_cd\\\": \\\"to\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"user_id\\\": null\\n }\\n ],\\n \\\"send_from\\\": {\\n \\\"email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"raw_name\\\": \\\"David Smith\\\",\\n \\\"recipient_type_cd\\\": null,\\n \\\"contact_id\\\": null,\\n \\\"user_id\\\": null\\n },\\n \\\"from_email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"to_email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"from_name\\\": \\\"David Smith\\\",\\n \\\"bcc_emails\\\": [],\\n \\\"cc_emails\\\": [],\\n \\\"send_from_info\\\": \\\"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\\\",\\n \\\"body_text\\\": \\\"Check out my email now!\\\\nDavid SmithApollo Knowledge Base \\\",\\n \\\"body_html\\\": \\\"
\\\\n
Check out my email now!
\\\\n
David Smith
\\\\n\\\\n
\\\\n
\\\",\\n \\\"body_html_loaded\\\": true,\\n \\\"appendment_html\\\": \\\"\\\",\\n \\\"appendment_html_loaded\\\": true,\\n \\\"subject\\\": \\\"Stats for you\\\",\\n \\\"contact\\\": {\\n \\\"contact_roles\\\": [],\\n \\\"id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"first_name\\\": \\\"Gina\\\",\\n \\\"last_name\\\": \\\"Larkin\\\",\\n \\\"name\\\": \\\"Gina Larkin\\\",\\n \\\"linkedin_url\\\": \\\"http://www.linkedin.com/in/gina-larkin-2e7a4d91\\\",\\n \\\"title\\\": \\\"Technical Writer\\\",\\n \\\"contact_stage_id\\\": \\\"6095a710bd01d100a506d4af\\\",\\n \\\"owner_id\\\": null,\\n \\\"creator_id\\\": \\\"669d3cf0105057019a5aca3c\\\",\\n \\\"person_id\\\": \\\"667a2eb71b47190001e2ef42\\\",\\n \\\"email_needs_tickling\\\": false,\\n \\\"organization_name\\\": \\\"Apollo.io\\\",\\n \\\"source\\\": \\\"chrome_extension_salesforce\\\",\\n \\\"original_source\\\": \\\"email_import\\\",\\n \\\"organization_id\\\": \\\"5e66b6381e05b4008c8331b8\\\",\\n \\\"headline\\\": \\\"Technical Writer @ Apollo.io\\\",\\n \\\"photo_url\\\": null,\\n \\\"present_raw_address\\\": \\\"Hillsboro, Oregon, United States\\\",\\n \\\"linkedin_uid\\\": null,\\n \\\"extrapolated_email_confidence\\\": null,\\n \\\"salesforce_id\\\": null,\\n \\\"salesforce_lead_id\\\": null,\\n \\\"salesforce_contact_id\\\": null,\\n \\\"salesforce_account_id\\\": null,\\n \\\"crm_owner_id\\\": null,\\n \\\"created_at\\\": \\\"2024-08-02T18:08:43.785Z\\\",\\n \\\"emailer_campaign_ids\\\": [\\n \\\"684b215edf80730019db612c\\\"\\n ],\\n \\\"direct_dial_status\\\": null,\\n \\\"direct_dial_enrichment_failed_at\\\": null,\\n \\\"city\\\": \\\"Hillsboro\\\",\\n \\\"country\\\": \\\"United States\\\",\\n \\\"state\\\": \\\"Oregon\\\",\\n \\\"email_status\\\": \\\"verified\\\",\\n \\\"email_source\\\": \\\"gmail_directory\\\",\\n \\\"account_id\\\": \\\"6518c6184f20350001a0b9c0\\\",\\n \\\"last_activity_date\\\": \\\"2025-06-12T21:34:16.000+00:00\\\",\\n \\\"hubspot_vid\\\": null,\\n \\\"hubspot_company_id\\\": null,\\n \\\"crm_id\\\": null,\\n \\\"sanitized_phone\\\": \\\"+14155550181\\\",\\n \\\"merged_crm_ids\\\": null,\\n \\\"updated_at\\\": \\\"2025-06-12T21:34:16.792Z\\\",\\n \\\"queued_for_crm_push\\\": null,\\n \\\"suggested_from_rule_engine_config_id\\\": null,\\n \\\"email_unsubscribed\\\": null,\\n \\\"person_deleted\\\": null,\\n \\\"call_opted_out\\\": null,\\n \\\"label_ids\\\": [],\\n \\\"has_pending_email_arcgate_request\\\": false,\\n \\\"has_email_arcgate_request\\\": false,\\n \\\"existence_level\\\": \\\"full\\\",\\n \\\"email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"email_from_customer\\\": null,\\n \\\"typed_custom_fields\\\": {},\\n \\\"custom_field_errors\\\": {},\\n \\\"crm_record_url\\\": null,\\n \\\"email_status_unavailable_reason\\\": null,\\n \\\"email_true_status\\\": \\\"Verified\\\",\\n \\\"updated_email_true_status\\\": true,\\n \\\"source_display_name\\\": \\\"Imported from Salesforce\\\",\\n \\\"twitter_url\\\": null,\\n \\\"facebook_url\\\": null,\\n \\\"contact_emails\\\": [\\n {\\n \\\"email_md5\\\": \\\"407887565213a5673207e861ac3523a3\\\",\\n \\\"email_sha256\\\": \\\"1e86ff1e4d45ea7321e8b39e604fea05e3bde13ff689ddf78afeccce4e53e4e6\\\",\\n \\\"email_status\\\": \\\"verified\\\",\\n \\\"extrapolated_email_confidence\\\": null,\\n \\\"position\\\": 0,\\n \\\"email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"free_domain\\\": false,\\n \\\"source\\\": \\\"Apollo\\\",\\n \\\"third_party_vendor_name\\\": null,\\n \\\"vendor_validation_statuses\\\": [],\\n \\\"email_needs_tickling\\\": false,\\n \\\"email_true_status\\\": \\\"Verified\\\",\\n \\\"email_status_unavailable_reason\\\": null\\n }\\n ],\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"show_intent\\\": false,\\n \\\"phone_numbers\\\": [\\n {\\n \\\"raw_number\\\": \\\"+1 415-555-0181\\\",\\n \\\"sanitized_number\\\": \\\"+14155550181\\\",\\n \\\"type\\\": \\\"work_hq\\\",\\n \\\"position\\\": 0,\\n \\\"status\\\": \\\"no_status\\\",\\n \\\"dnc_status\\\": null,\\n \\\"dnc_other_info\\\": {},\\n \\\"dialer_flags\\\": null,\\n \\\"source_name\\\": \\\"Apollo\\\",\\n \\\"vendor_validation_statuses\\\": [],\\n \\\"third_party_vendor_name\\\": null\\n }\\n ],\\n \\\"account_phone_note\\\": null,\\n \\\"free_domain\\\": false,\\n \\\"email_domain_catchall\\\": false\\n },\\n \\\"emailer_message_events\\\": [],\\n \\\"num_opens\\\": 0,\\n \\\"num_clicks\\\": 0,\\n \\\"campaign_name\\\": \\\"Stats Sequences DO NOT USE\\\",\\n \\\"campaign_max_emails_per_day\\\": null,\\n \\\"campaign_position\\\": 1,\\n \\\"step_max_emails_per_day\\\": null\\n }\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aca6595-937b-475a-b4dd-069ac5799944", "name": "401", "originalRequest": { "url": { "path": [ "emailer_messages", ":id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ac9fbb3-1122-452a-a2db-5e1b718642a4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "emailer_messages", ":id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_messages/activities. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b066747-a915-4b38-8431-0425bc617a90", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "emailer_messages", ":id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"Could not find message.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "457f9400-d69a-48e7-9ec1-322089a84d41", "name": "Search for Outreach Emails", "request": { "name": "Search for Outreach Emails", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_messages/search` or `Master API key`\n\n**OAuth scopes:** `emailer_messages_search`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Search for Outreach Emails endpoint to find emails that your team has created and sent as part of Apollo sequences.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible. This limitation does not restrict your access to Apollo's database; you just need to access the data in batches.", "type": "text/plain" }, "url": { "path": [ "emailer_messages", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "emailer_message_stats[]", "value": "", "description": "Find emails based on their current status, such as whether they were delivered or opened. You can add multiple statuses.

Possible values include:
  • `delivered`
  • `scheduled`
  • `drafted`
  • `not_opened`
  • `opened`
  • `clicked`
  • `unsubscribed`
  • `demoed`
  • `bounced`
  • `spam_blocked`
  • `failed_other`
" }, { "disabled": false, "key": "emailer_message_reply_classes[]", "value": "", "description": "Find emails based on the response sentiment of the recipient. This can include the recipient expressing interest in meeting or having a follow-up question. You can add multiple values.

Possible values include:
  • `willing_to_meet`
  • `follow_up_question`
  • `person_referral`
  • `out_of_office`
  • `already_left_company_or_not_right_person`
  • `not_interested`
  • `unsubscribe`
  • `none_of_the_above`
" }, { "disabled": false, "key": "user_ids[]", "value": "", "description": "Find emails sent by specific users in your team's Apollo account. You can add multiple users.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`" }, { "disabled": false, "key": "email_account_id_and_aliases", "value": "" }, { "disabled": false, "key": "emailer_campaign_ids[]", "value": "", "description": "Search for emails that are included in specific sequences in your Apollo account. You can search multiple sequences. Any sequence not included in this parameter will be exclude from search results.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" }, { "disabled": false, "key": "not_emailer_campaign_ids[]", "value": "", "description": "Exclude emails from specific sequences in your Apollo account. You can exclude multiple sequences. Any sequence not excluded using this parameter will be included in search results.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`" }, { "disabled": false, "key": "emailer_message_date_range_mode", "value": "", "description": "Use this parameter in combination with the `emailer_message_date_range[max]` and `emailer_message_date_range[min]` parameters. Find emails based on 1 of the following options:
  • `due_at`: When emails are scheduled to be delivered.
  • `completed_at`: When emails were delivered.
" }, { "disabled": false, "key": "emailer_message_date_range[max]", "value": "", "description": "Set the upper bound of the date range you want to search.

Use this parameter in combination with the `emailer_message_date_range[min]` and `emailer_message_date_range_mode` parameters. This date should fall after the `emailer_message_date_range[min]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`" }, { "disabled": false, "key": "emailer_message_date_range[min]", "value": "", "description": "Set the lower bound of the date range you want to search.

Use this parameter in combination with the `emailer_message_date_range[max]` and `emailer_message_date_range_mode` parameters. This date should fall before the `emailer_message_date_range[max]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`" }, { "disabled": false, "key": "not_sent_reason_cds[]", "value": "", "description": "Find emails based on the reason they were not sent. You can add multiple values.

Possible values include:
  • `contact_stage_safeguard`
  • `same_account_reply`
  • `account_stage_safeguard`
  • `email_unverified`
  • `snippets_missing`
  • `personalized_opener_missing`
  • `thread_reply_original_email_missing`
  • `no_active_email_account`
  • `email_format_invalid`
  • `ownership_permission`
  • `email_service_provider_delivery_failure`
  • `sendgrid_dropped_email`
  • `mailgun_dropped_email`
  • `gdpr_compliance`
  • `not_valid_hard_bounce_detected`
  • `other_safeguard`
  • `new_job_change_detected`
  • `email_on_global_bounce_list`
" }, { "disabled": false, "key": "q_keywords", "value": "", "description": "Add keywords to narrow the search of the emails in your team's Apollo account.

Keywords should directly match at least part of an email's content. For example, searching the keyword `James` might return emails that were sent by `James Smith`.

Example: `Jane`" }, { "disabled": false, "key": "page", "value": "", "description": "The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`" }, { "disabled": false, "key": "per_page", "value": "", "description": "The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance.

Use the `page` parameter to search the different pages of data.

Example: `10`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3f5a8249-8c5a-4dc7-b053-7223ff392954", "name": "OK", "originalRequest": { "url": { "path": [ "emailer_messages", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_message_stats[]", "value": "" }, { "key": "emailer_message_reply_classes[]", "value": "" }, { "key": "user_ids[]", "value": "" }, { "key": "email_account_id_and_aliases", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "not_emailer_campaign_ids[]", "value": "" }, { "key": "emailer_message_date_range_mode", "value": "" }, { "key": "emailer_message_date_range[max]", "value": "" }, { "key": "emailer_message_date_range[min]", "value": "" }, { "key": "not_sent_reason_cds[]", "value": "" }, { "key": "q_keywords", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"breadcrumbs\\\": [],\\n \\\"emailer_messages\\\": [\\n {\\n \\\"id\\\": \\\"684b2203a2ce950021cbf730\\\",\\n \\\"user_id\\\": \\\"66302798d03b9601c7934ebf\\\",\\n \\\"status\\\": \\\"failed\\\",\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"provider_message_id\\\": null,\\n \\\"to_name\\\": \\\"Gina Larkin\\\",\\n \\\"due_at\\\": \\\"2025-06-12T18:57:08.553+00:00\\\",\\n \\\"completed_at\\\": null,\\n \\\"emailer_touch_id\\\": \\\"684b216ec95a4f001d968d1b\\\",\\n \\\"emailer_campaign_id\\\": \\\"684b215edf80730019db612c\\\",\\n \\\"emailer_step_id\\\": \\\"684b216ec95a4f001d968d19\\\",\\n \\\"failed_at\\\": \\\"2025-06-12T19:04:06.820+00:00\\\",\\n \\\"failure_reason\\\": \\\"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\\\",\\n \\\"attachment_ids\\\": [],\\n \\\"enable_tracking\\\": true,\\n \\\"type\\\": \\\"outreach_automatic_email\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"provider_thread_id\\\": null,\\n \\\"schedule_delayed_reason\\\": null,\\n \\\"demoed\\\": null,\\n \\\"email_account_id\\\": \\\"6633baaece5fbd01c791d7ca\\\",\\n \\\"due_at_manually_changed\\\": true,\\n \\\"not_sent_reason\\\": \\\"account_stage_safeguard\\\",\\n \\\"bounce\\\": null,\\n \\\"spam_blocked\\\": null,\\n \\\"tracking_disabled_reason\\\": null,\\n \\\"created_at\\\": \\\"2025-06-12T18:52:51.021Z\\\",\\n \\\"async_sending\\\": true,\\n \\\"due_at_source\\\": \\\"Email was sent using Send Now action\\\",\\n \\\"crm_id\\\": null,\\n \\\"replied\\\": null,\\n \\\"needs_dynamic_assemble\\\": true,\\n \\\"personalized_opener\\\": null,\\n \\\"reply_class\\\": null,\\n \\\"schedule_delayed_limit_reason\\\": null,\\n \\\"schedule_delayed_reason_details\\\": null,\\n \\\"sensitive_info_redacted\\\": null,\\n \\\"account_id\\\": \\\"6518c6184f20350001a0b9c0\\\",\\n \\\"recipients\\\": [\\n {\\n \\\"email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"raw_name\\\": \\\"Gina Larkin\\\",\\n \\\"recipient_type_cd\\\": \\\"to\\\",\\n \\\"contact_id\\\": \\\"66ad20ab23d5d40001c8d07d\\\",\\n \\\"user_id\\\": null\\n }\\n ],\\n \\\"send_from\\\": {\\n \\\"email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"raw_name\\\": \\\"David Smith\\\",\\n \\\"recipient_type_cd\\\": null,\\n \\\"contact_id\\\": null,\\n \\\"user_id\\\": null\\n },\\n \\\"from_email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"to_email\\\": \\\"gina.larkin@apollo.io\\\",\\n \\\"from_name\\\": \\\"David Smith\\\",\\n \\\"bcc_emails\\\": [],\\n \\\"cc_emails\\\": [],\\n \\\"send_from_info\\\": \\\"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\\\",\\n \\\"body_text\\\": \\\"Check out my email now!David SmithApollo Knowledge Base \\\",\\n \\\"body_html\\\": \\\"
Check out my email now!

David Smith
\\\",\\n \\\"body_html_loaded\\\": true,\\n \\\"appendment_html\\\": \\\"\\\",\\n \\\"appendment_html_loaded\\\": true,\\n \\\"subject\\\": \\\"Stats for you\\\",\\n \\\"campaign_name\\\": \\\"Stats Sequences DO NOT USE\\\",\\n \\\"campaign_max_emails_per_day\\\": null,\\n \\\"campaign_position\\\": 1,\\n \\\"step_max_emails_per_day\\\": null\\n },\\n {\\n \\\"id\\\": \\\"684b2203a2ce950021cbf72d\\\",\\n \\\"user_id\\\": \\\"66302798d03b9601c7934ebf\\\",\\n \\\"status\\\": \\\"failed\\\",\\n \\\"time_zone\\\": \\\"America/Los_Angeles\\\",\\n \\\"provider_message_id\\\": null,\\n \\\"to_name\\\": \\\"Wesley Tran\\\",\\n \\\"due_at\\\": \\\"2025-06-12T18:57:14.197+00:00\\\",\\n \\\"completed_at\\\": null,\\n \\\"emailer_touch_id\\\": \\\"684b216ec95a4f001d968d1b\\\",\\n \\\"emailer_campaign_id\\\": \\\"684b215edf80730019db612c\\\",\\n \\\"emailer_step_id\\\": \\\"684b216ec95a4f001d968d19\\\",\\n \\\"failed_at\\\": \\\"2025-06-12T19:04:09.180+00:00\\\",\\n \\\"failure_reason\\\": \\\"Contact stage is Interested. Change stage for contact or adjust settings under Sequence => Settings and retry.\\\",\\n \\\"attachment_ids\\\": [],\\n \\\"enable_tracking\\\": true,\\n \\\"type\\\": \\\"outreach_automatic_email\\\",\\n \\\"contact_id\\\": \\\"6601a68fca35d8000718d42b\\\",\\n \\\"provider_thread_id\\\": null,\\n \\\"schedule_delayed_reason\\\": null,\\n \\\"demoed\\\": null,\\n \\\"email_account_id\\\": \\\"6633baaece5fbd01c791d7ca\\\",\\n \\\"due_at_manually_changed\\\": true,\\n \\\"not_sent_reason\\\": \\\"contact_stage_safeguard\\\",\\n \\\"bounce\\\": null,\\n \\\"spam_blocked\\\": null,\\n \\\"tracking_disabled_reason\\\": null,\\n \\\"created_at\\\": \\\"2025-06-12T18:52:51.021Z\\\",\\n \\\"async_sending\\\": true,\\n \\\"due_at_source\\\": \\\"Email was sent using Send Now action\\\",\\n \\\"crm_id\\\": null,\\n \\\"replied\\\": null,\\n \\\"needs_dynamic_assemble\\\": true,\\n \\\"personalized_opener\\\": null,\\n \\\"reply_class\\\": null,\\n \\\"schedule_delayed_limit_reason\\\": null,\\n \\\"schedule_delayed_reason_details\\\": null,\\n \\\"sensitive_info_redacted\\\": null,\\n \\\"account_id\\\": \\\"6518c6184f20350001a0b9c0\\\",\\n \\\"recipients\\\": [\\n {\\n \\\"email\\\": \\\"wesley.t@example.com\\\",\\n \\\"raw_name\\\": \\\"Wesley Tran\\\",\\n \\\"recipient_type_cd\\\": \\\"to\\\",\\n \\\"contact_id\\\": \\\"6601a68fca35d8000718d42b\\\",\\n \\\"user_id\\\": null\\n }\\n ],\\n \\\"send_from\\\": {\\n \\\"email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"raw_name\\\": \\\"David Smith\\\",\\n \\\"recipient_type_cd\\\": null,\\n \\\"contact_id\\\": null,\\n \\\"user_id\\\": null\\n },\\n \\\"from_email\\\": \\\"test.marcus.hale@apollomail.io\\\",\\n \\\"to_email\\\": \\\"wesley.t@example.com\\\",\\n \\\"from_name\\\": \\\"David Smith\\\",\\n \\\"bcc_emails\\\": [],\\n \\\"cc_emails\\\": [],\\n \\\"send_from_info\\\": \\\"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\\\",\\n \\\"body_text\\\": \\\"Check out my email now!David SmithApollo Knowledge Base \\\",\\n \\\"body_html\\\": \\\"
Check out my email now!

David Smith
\\\",\\n \\\"body_html_loaded\\\": true,\\n \\\"appendment_html\\\": \\\"\\\",\\n \\\"appendment_html_loaded\\\": true,\\n \\\"subject\\\": \\\"Stats for you\\\",\\n \\\"campaign_name\\\": \\\"Stats Sequences DO NOT USE\\\",\\n \\\"campaign_max_emails_per_day\\\": null,\\n \\\"campaign_position\\\": 1,\\n \\\"step_max_emails_per_day\\\": null\\n }\\n ],\\n \\\"emailer_steps\\\": [\\n {\\n \\\"id\\\": \\\"684b216ec95a4f001d968d19\\\",\\n \\\"emailer_campaign_id\\\": \\\"684b215edf80730019db612c\\\",\\n \\\"wait_time\\\": 0,\\n \\\"wait_mode\\\": \\\"minute\\\",\\n \\\"max_emails_per_day\\\": null,\\n \\\"exact_datetime\\\": null,\\n \\\"auto_skip_in_x_days\\\": null,\\n \\\"position\\\": 1\\n },\\n {\\n \\\"id\\\": \\\"684886e2e7c9bd0011e0b239\\\",\\n \\\"emailer_campaign_id\\\": \\\"6848868536ec86001d300ce6\\\",\\n \\\"wait_time\\\": 30,\\n \\\"wait_mode\\\": \\\"minute\\\",\\n \\\"max_emails_per_day\\\": null,\\n \\\"exact_datetime\\\": null,\\n \\\"auto_skip_in_x_days\\\": null,\\n \\\"position\\\": 1\\n },\\n {\\n \\\"id\\\": \\\"67bde6d5b5eeec0021ad09c4\\\",\\n \\\"emailer_campaign_id\\\": \\\"67bde6d5b5eeec0021ad09c2\\\",\\n \\\"wait_time\\\": 20,\\n \\\"wait_mode\\\": \\\"day\\\",\\n \\\"max_emails_per_day\\\": null,\\n \\\"exact_datetime\\\": null,\\n \\\"auto_skip_in_x_days\\\": null,\\n \\\"position\\\": 1\\n }\\n ],\\n \\\"num_fetch_result\\\": null\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9111758-23b5-42aa-a5d4-2d5cece11630", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "emailer_messages", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_message_stats[]", "value": "" }, { "key": "emailer_message_reply_classes[]", "value": "" }, { "key": "user_ids[]", "value": "" }, { "key": "email_account_id_and_aliases", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "not_emailer_campaign_ids[]", "value": "" }, { "key": "emailer_message_date_range_mode", "value": "" }, { "key": "emailer_message_date_range[max]", "value": "" }, { "key": "emailer_message_date_range[min]", "value": "" }, { "key": "not_sent_reason_cds[]", "value": "" }, { "key": "q_keywords", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7ed6fa3-291b-4716-b216-e5fe31ce913c", "name": "422", "originalRequest": { "url": { "path": [ "emailer_messages", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_message_stats[]", "value": "" }, { "key": "emailer_message_reply_classes[]", "value": "" }, { "key": "user_ids[]", "value": "" }, { "key": "email_account_id_and_aliases", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "not_emailer_campaign_ids[]", "value": "" }, { "key": "emailer_message_date_range_mode", "value": "" }, { "key": "emailer_message_date_range[max]", "value": "" }, { "key": "emailer_message_date_range[min]", "value": "" }, { "key": "not_sent_reason_cds[]", "value": "" }, { "key": "q_keywords", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"Invalid parameter passed in. Page * per page number is over threshold.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41a4b428-2938-4cf2-a8be-874b580f0973", "name": "429", "originalRequest": { "url": { "path": [ "emailer_messages", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "emailer_message_stats[]", "value": "" }, { "key": "emailer_message_reply_classes[]", "value": "" }, { "key": "user_ids[]", "value": "" }, { "key": "email_account_id_and_aliases", "value": "" }, { "key": "emailer_campaign_ids[]", "value": "" }, { "key": "not_emailer_campaign_ids[]", "value": "" }, { "key": "emailer_message_date_range_mode", "value": "" }, { "key": "emailer_message_date_range[max]", "value": "" }, { "key": "emailer_message_date_range[min]", "value": "" }, { "key": "not_sent_reason_cds[]", "value": "" }, { "key": "q_keywords", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_messages/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73b4d689-2500-43d3-9408-411d47343e5d", "name": "Get Contact Sequence Activity", "request": { "name": "Get Contact Sequence Activity", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/activity_feed` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_activity_feed`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Get Contact Sequence Activity endpoint to retrieve one contact's sequence timeline: when they were added to a sequence, when their enrollment was paused, resumed, failed, finished, or removed, and when they replied. This is the same enrollment activity that the contact's timeline shows in Apollo.

You must provide a `contact_id`, and that contact must belong to your team. This endpoint returns activity for a single contact — it doesn't return activity for every contact in a sequence. To narrow the timeline to one sequence, also provide a `sequence_id`.

Events are returned newest-first, and each response contains at most 50 events. There is no `page` parameter: the endpoint always returns the most recent events, so use `per_page` to request fewer than 50.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact. To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\",\n \"sequence_id\": \"\",\n \"per_page\": 50\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e76171c6-9d4d-4a65-b3cf-905d6fe7cf4d", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\",\n \"events\": [\n {\n \"type\": \"removed\",\n \"occurred_at\": \"2026-07-28T10:26:55Z\",\n \"sequence_id\": \"66e9e215ece19801b219997f\",\n \"sequence_name\": \"Q2 Outreach\"\n },\n {\n \"type\": \"completed\",\n \"occurred_at\": \"2026-07-27T10:26:55Z\",\n \"sequence_id\": \"66e9e215ece19801b219997f\",\n \"sequence_name\": \"Q2 Outreach\"\n },\n {\n \"type\": \"replied\",\n \"occurred_at\": \"2026-07-26T10:26:55Z\",\n \"sequence_id\": \"66e9e215ece19801b219997f\",\n \"sequence_name\": \"Q2 Outreach\",\n \"emailer_message_id\": \"66e8cc45028aed019c25d724\"\n },\n {\n \"type\": \"paused\",\n \"occurred_at\": \"2026-07-22T10:26:55Z\",\n \"sequence_id\": \"66e9e215ece19801b219997f\",\n \"sequence_name\": \"Q2 Outreach\",\n \"reason\": \"manually paused\"\n },\n {\n \"type\": \"enrolled\",\n \"occurred_at\": \"2026-07-20T10:26:55Z\",\n \"sequence_id\": \"66e9e215ece19801b219997f\",\n \"sequence_name\": \"Q2 Outreach\",\n \"step_position\": 2\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "216517f1-4a1a-4266-b24c-689d48ffdb3c", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f9a9b06-b942-42c7-b4d5-8bc579c5d4eb", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/activity_feed. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6584a231-54d1-4c74-beb2-1dc7bb2a97c8", "name": "404", "originalRequest": { "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\\"error\\\": \\\"Contact not found\\\"}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "273a44b3-0982-4def-9386-9c60195ec7a8", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", "activity_feed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"66e34b81740c50074e3d1bd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/activity_feed is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d3209a4-074b-4174-946f-4f36fa3e1692", "name": "Activate a Sequence", "request": { "name": "Activate a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/approve` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_approve`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Activate a Sequence endpoint to start an inactive sequence. Once activated, the sequence begins sending emails to its contacts on the configured schedule. The sequence must have at least one step configured before it can be activated.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "c486add3-d08d-4106-a1cb-8763ee6d929d", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emailer_campaign\": {\n \"id\": \"66e9e215ece19801b219997f\",\n \"unique_scheduled\": 5,\n \"active\": true\n },\n \"emailer_steps\": [\n {\n \"id\": \"66e9e215ece19801b2199980\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 1,\n \"wait_time\": 1,\n \"type\": \"auto_email\",\n \"note\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83724606-c40d-4585-8425-1a60242b0825", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdd82bc3-4671-4d02-a60f-e2ea8d8e9045", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/approve. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20133f6e-65c1-47a9-8c1f-38c9c258f7eb", "name": "422", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\\"error\\\": \\\"The sequence is already active.\\\"}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdfb8024-766a-47c1-bb2d-f1148c95d7bc", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/approve is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cbe3058-df6b-43f5-a621-8dac357bd153", "name": "Deactivate a Sequence", "request": { "name": "Deactivate a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/abort` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_abort`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Deactivate a Sequence endpoint to stop an active sequence. Once deactivated, the sequence pauses all contacts and stops sending emails.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "b991c4bb-c609-4e8f-8529-176a763abac3", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emailer_campaign\": {\n \"id\": \"66e9e215ece19801b219997f\",\n \"unique_scheduled\": 5,\n \"active\": false\n },\n \"emailer_steps\": [\n {\n \"id\": \"66e9e215ece19801b2199980\",\n \"emailer_campaign_id\": \"66e9e215ece19801b219997f\",\n \"position\": 1,\n \"wait_time\": 1,\n \"type\": \"auto_email\",\n \"note\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e26ad21b-76a8-42b5-8860-55a819c6b39c", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "338392d6-8c07-4f0e-bbc2-c16e81d54fee", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/abort. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fca89b32-dae5-4e6b-aed2-c6cefe8adc97", "name": "422", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\\"error\\\": \\\"The sequence is already inactive.\\\"}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef770e05-025b-41d8-9b69-75d4885b7f72", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/abort is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a04b623-8798-4a82-81a1-98a4e84c8860", "name": "Archive a Sequence", "request": { "name": "Archive a Sequence", "description": { "content": "## Endpoint essentials\n\n**API key access:** `api/v1/emailer_campaigns/archive` or `Master API key`\n\n**OAuth scopes:** `emailer_campaigns_archive`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Archive a Sequence endpoint to archive a sequence. Archiving a sequence marks it as inactive and finishes all contacts currently in the sequence. You must be the owner of the sequence or have full access sharing permissions to archive it.", "type": "text/plain" }, "url": { "path": [ "emailer_campaigns", ":sequence_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "92776fa6-d6b8-4c9d-87c9-7d30694589e5", "name": "200", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emailer_campaign\": {\n \"id\": \"66e9e215ece19801b219997f\",\n \"active\": false,\n \"archived\": true,\n \"deleted\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27610b52-9069-4296-81e9-cc112e03bc76", "name": "401", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "Invalid API key. See https://docs.apollo.io/reference/authentication for how to authenticate.", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28a8131e-47cf-41f7-b084-1f083418601c", "name": "403", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"error\\\": \\\"This API key is not authorized to access api/v1/emailer_campaigns/archive. Request an API key from your administrator that includes this endpoint in its configured scope.\\\",\\n \\\"error_code\\\": \\\"API_INACCESSIBLE\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "169dbcf3-cc5d-438f-a201-4b6921c611cc", "name": "429", "originalRequest": { "url": { "path": [ "emailer_campaigns", ":sequence_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "sequence_id", "description": "(Required) The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"{\\n \\\"message\\\": \\\"The maximum number of api calls allowed for api/v1/emailer_campaigns/archive is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\\\"\\n}\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.apollo.io/api/v1", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "0f10b905-5400-4143-bc7f-c1421022c4a6", "name": "Apollo API — Sequences", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Apollo API provides programmatic access to [Apollo](https://www.apollo.io/), the all-in-one sales intelligence and engagement platform. Use it to enrich people and company data (individually or in bulk), search Apollo's database of over 240 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.\n\n## Base URL\n\nAll API requests are made to `https://api.apollo.io/api/v1`.\n\n## Authentication\n\n- **Apollo users** authenticate with an API key passed in the `x-api-key` request header. See [Create API Keys](https://docs.apollo.io/docs/create-api-key).\n- **Apollo partners** building integrations on behalf of mutual users authenticate with the [OAuth 2.0 authorization flow](https://docs.apollo.io/docs/use-oauth-20-authorization-flow-to-access-apollo-user-information-partners).\n\n## Rate limits & credits\n\nRate limits and credit consumption depend on your [Apollo pricing plan](https://docs.apollo.io/docs/api-pricing). Check your current limits and usage with the [View API Usage Stats and Rate Limits](https://docs.apollo.io/reference/view-api-usage-stats) endpoint. For more details, see [Rate Limits](https://docs.apollo.io/reference/rate-limits) and the [API FAQs](https://docs.apollo.io/docs/apollo-api-faqs).\n\nNew to the API? Start with the [Apollo API overview](https://docs.apollo.io/reference/apollo-api).\n\nContact Support:\n Name: Apollo API Support", "type": "text/plain" } } }