v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Sequences

Update 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 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 <a href="https://docs.apollo.io/reference/create-sequence">Create a Sequence endpoint</a>. This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.

put/sequences/{id}

Path parameters

idstring required

The Apollo ID for the sequence that you want to update. 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: 66e34b81740c50074e3d1bd4

Request body

namestring

Update the name of the sequence. Example: New outbound sequence

activeboolean

Turn the sequence on (true) or off (false). When set to true, Apollo resumes scheduling for the sequence; when set to false, pending work is paused.

creation_type'draft' | 'new' | 'ai_assistant'

The creation type for the sequence. A draft sequence is automatically promoted to new (or ai_assistant) when steps are added.

permissionsstring

Update who can access the sequence. Example: team_can_use

emailer_schedule_idstring

Attach a sending schedule to the sequence. Must reference a non-empty schedule that belongs to your team. Example: 6095a710bd01d100a506d4af

label_namesstring[]

Replace the labels (folders) this sequence belongs to. Passing new values will overwrite the existing labels.

max_emails_per_dayinteger

Maximum number of emails that can be sent per day for this sequence.

same_account_reply_delay_daysinteger

Number of days to wait before contacting another person at the same account.

cc_emailsstring

Comma-separated list of email addresses to CC on emails sent from this sequence.

bcc_emailsstring

Comma-separated list of email addresses to BCC on emails sent from this sequence.

Example request

{
  "emailer_steps": [
    {
      "type": "auto_email",
      "emailer_touches": [
        {
          "generation_options": [
            {
              "type": "ai_full_email",
              "field_name": "AI Full Email df7fdbd8"
            }
          ],
          "generation_tone": {
            "tone_type": "Direct"
          }
        }
      ]
    }
  ]
}

Response

200

idstring

namestring

activeboolean

archivedboolean

created_atstring

updated_atstring

num_stepsinteger

Example response

{
  "id": "66e34b81740c50074e3d1bd4",
  "name": "first campaign",
  "active": true,
  "created_at": "2024-09-12T20:13:53.207Z",
  "updated_at": "2024-09-12T20:14:53.134Z",
  "num_steps": 1,
  "steps": [
    {
      "id": "66e361494acd1307386d4073",
      "position": 1,
      "step_type": "auto_email",
      "wait_time": 1,
      "wait_mode": "day"
    }
  ],
  "emailer_campaign": {
    "id": "66e34b81740c50074e3d1bd4",
    "name": "first campaign",
    "active": true
  },
  "emailer_steps": [
    {
      "id": "66e361494acd1307386d4073",
      "position": 1
    }
  ],
  "emailer_touches": [
    {
      "id": "66e361494acd1307386d4074",
      "status": "approved"
    }
  ]
}