Sequences
Sequences v3 endpoints
Sequences are automated email courses that deliver content to subscribers over time. They help you nurture leads and deliver value through a series of scheduled emails.
Sequences were formerly referred to as Courses. API V3 retains the previous naming conventions, but will accept requests to sequences as the endpoint as well. List sequences
Returns a list of sequences for your account.
Endpoint
GET /v3/sequences
Parameters
Your account API key
Add subscriber to a sequence
Subscribe an email address to one of your sequences.
Endpoint
POST /v3/sequences/#{sequence_id}/subscribe
Parameters
Your account API key
The ID of the sequence you want to subscribe to
Subscriber email address
Subscriber first name
Object of key/value pairs for custom field(s). The custom field(s) must exist before you can use it here.
Array of tag ids to subscribe to
Deprecated Parameters
Array of sequence ids to subscribe to. You should add the subscriber to each course individually.
Array of form ids to subscribe to. You should add the subscriber to the form directly.
Subscriber first name. You should prefer using first_name listed above.
List subscriptions to a sequence
List subscriptions to a sequence including subscriber data.
Endpoint
GET /v3/sequences/#{sequence_id}/subscriptions
Parameters
Your API secret key
The ID of the sequence you want to retrieve subscriptions for
Sort order for results (asc or desc). asc to list subscribers added oldest to newest, desc to list subscribers added newest to oldest. Default is asc.
Filter by subscriber state (active or cancelled). Receive only active subscribers or cancelled subscribers.
The page of results being requested. Default value is 1. Each page of results will contain up to 50 subscriptions.