Sequences

Use these endpoints to create, update, and find sequences in your team's Apollo workspace. You can also retrieve sending schedules, enroll contacts, review contact activity, and activate, deactivate, or archive sequences.

Key concepts

Sequences and contacts	Sequences are outreach campaigns with planned steps for engaging contacts. Only saved contacts can be enrolled. To save a person before enrollment, use create a contact.
Identifying a sequence	Search and create responses return a sequence `id`. Some endpoints refer to sequences as emailer campaigns and use parameters such as `emailer_campaign_id`. These values identify the same sequence.
Steps and sending schedules	Steps define the outreach actions in a sequence. Sending schedules control when sequence emails can send. Use `emailer_steps` to configure steps and a schedule ID as `emailer_schedule_id` when creating or updating a sequence.
Sequence state and contact status	Activating or deactivating a sequence affects outreach for the whole sequence. Updating a contact's status affects that contact's enrollment. Archiving makes the sequence inactive and finishes all enrolled contacts.

Choose an endpoint

I want to . . .	Use this
Create a sequence with steps and email templates	Create a sequence
Change a sequence's settings, steps, email content, or owner	Update a sequence
Find sequences in my team's Apollo workspace	Search for sequences
Retrieve available sending schedules and their IDs	List email schedules
Enroll saved contacts in a sequence	Add contacts to a sequence
Stop, finish, or remove contacts from sequences	Update contact status in a sequence
Review one contact's sequence enrollment and reply activity	Get contact sequence activity
Start an inactive sequence	Activate a sequence
Pause outreach for all contacts in a sequence	Deactivate a sequence
Archive a sequence and finish its enrolled contacts	Archive a sequence

Enroll contacts in a sequence

Add saved contacts to an existing sequence and choose the mailbox that sends their emails.

Call search for sequences and retain the target sequence's id.
Call search for contacts and retain the id of each contact you want to enroll.
Call get a list of email accounts and retain the ID of the sending mailbox.
Call add contacts to a sequence with the sequence ID as both sequence_id and emailer_campaign_id, the contact IDs in contact_ids[], and the mailbox ID as send_email_from_email_account_id.
If the sequence is inactive, call activate a sequence when you're ready to start outreach.

The sequence must have at least one configured step before activation. Email touches need approved status and a template with a non-empty body to send. Use update a sequence to configure the steps and sending schedule.

Learn more: Use the add contacts to a sequence and activate a sequence references to dig in to the workflow.

Review activity and finish outreach

Review a contact's recent sequence activity, then finish their enrollment when further outreach is no longer needed.

Retain the contact and sequence IDs from enrollment, or retrieve them with search for contacts and search for sequences.
Pass the contact ID as contact_id and the sequence ID as sequence_id to get contact sequence activity. Review enrollment changes and reply events to decide whether outreach should continue.
To finish enrollment, call update contact status in a sequence with the contact ID in contact_ids[], the sequence ID in emailer_campaign_ids[], and mode set to mark_as_finished.

Contact sequence activity returns the most recent events for one contact, rather than activity for every contact in a sequence. To remove the contact instead of marking them finished, set mode to remove.

Learn more: Use the get contact sequence activity and update contact status in a sequence references to explore enrollment activity and status changes.