v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Sequences

Update Contact Status in a Sequence

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

<a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time. Use the Update Contact Status in a Sequence endpoint to either mark contacts as having finished a sequence, or to remove them from a sequence entirely. This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.

post/emailer_campaigns/remove_or_stop_contact_ids

Query parameters

emailer_campaign_ids[]string[] 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 <a href="https://docs.apollo.io/reference/search-for-sequences" target="_blank">Search for Sequences endpoint</a> and identify the id value for the sequence. Example: 66e9e215ece19801b219997f

contact_ids[]string[] 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 <a href="https://docs.apollo.io/reference/search-for-contacts" target="_blank">Search for Contacts endpoint</a> and identify the id value for the contact. Example: 66e34b81740c50074e3d1bd4

modestring required

Choose 1 of the following options to update the sequence status of the contacts: <ul> <li> mark_as_finished: Mark the contacts as having finished the sequence. </li> <li> remove: Remove the contacts from the sequence. </li> <li> stop: Indicate that the contacts progress in the sequence has halted. </li> </ul>

Response

200

Example response

{
  "entity_progress_job": {
    "id": "66e9fca8cc087302d18b83be",
    "user_id": "60affe7d6e270a00f5db6fe4",
    "job_type": "sequence_remove_stop_contacts",
    "entity_ids": [
      "66e9e9e21fbdad01b2b33bbd"
    ],
    "params": {
      "sequence_ids": [
        "66e9e215ece19801b219997f"
      ],
      "mode": "mark_as_finished",
      "api_key": "dC3MrapHs3ktwPi1uy_-vp"
    },
    "batch_size": 999
  }
}