API
Get API key

Update a Sequence

put
https://api.apollo.io/api/v1/sequences/

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

Sequences 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.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out Create an API Key to learn how to create a master key.

✅

No Credit Cost

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

Sequences 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.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out Create an API Key to learn how to create a master key.

Path Params
string
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

Body Params
string

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

boolean

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.

string
enum

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

Allowed:
string

Update who can access the sequence. Example: team_can_use

string

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

label_names
array of strings

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

label_names
integer

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

integer

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

string

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

string

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

emailer_steps
array of objects

The ordered list of steps in the sequence. Include an id to update an existing step; omit it to create a new step. Steps that exist on the sequence but are not present in this array are removed.

emailer_steps
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 18 minutes ago

What’s Next

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 18 minutes ago

What’s Next

Did this page help you?