Update a Sequence

put

https://api.apollo.io/api/v1/sequences/{id}

Endpoint essentials
API key access	`api/v1/sequences/update` or `Master API key`
OAuth scopes	`emailer_campaigns_update`
Credit usage	`0 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.

Reassigning sequence ownership

Unlike Create a 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 to look up IDs.

This 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 for how the acting user is resolved.

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

name

string

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

active

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.

creation_type

string

enum

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

Allowed:

permissions

string

Update who can access the sequence. Example: team_can_use

user_id

string

Reassign the sequence to a different owner. Pass the Apollo user ID of the intended owner; the response returns it as user_id and its alias object_owner_id.

Use this to correct ownership on sequences created with an API key, which aren't owned by the teammate who created the key (see Authentication). Create a Sequence ignores user_id, so reassignment happens here.

Use the Get a List of Users endpoint to retrieve IDs for the users in your workspace. Example: 66302798d03b9601c7934ebf

emailer_schedule_id

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

max_emails_per_day

integer

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

same_account_reply_delay_days

integer

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

cc_emails

string

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

bcc_emails

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

Update a Sequence

Reassigning sequence ownership

What’s Next

What’s Next

Reassigning sequence ownership

200200

401401

404404

422422

429429

What’s Next

What’s Next