/sequences/:id/recipients

Adds recipients to a sequence and, unless they are kept as drafts, starts sending to them. You need the sequence activation feature, otherwise the response is 403 with an empty body.

The response is 200 even when some or all recipients were not added. Check each entry's status: success (added), active (already active in another sequence and this sequence prevents double booking), duplicated (already in this sequence), unsubscribed or domain-unsubscribed, or error with the reasons in errors.

To keep a recipient in the draft without sending, set scheduledAt: false on that recipient. A top-level scheduledAt: false is treated as "now" and sends right away.

If the sequence uses variables in its subject or body, each recipient must have a non-empty value for them, otherwise it gets an error entry. Set allowMissingVariables to skip that check. An email or Email variable, when given, must be a valid email address.

A request with an empty recipients array returns {"recipients": []} without checking the sequence. More than 5,000 recipients in one request returns 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the sequence to add recipients to.

Body Params
recipients
array of objects
required

The recipients to add.

recipients*
int64

When to start the sequence for these recipients, as a Unix timestamp in milliseconds (13 digits). Leave out to start now. Each recipient's own scheduledAt takes precedence. false here is treated as "now"; to keep recipients in the draft, set false on each recipient instead.

boolean
Defaults to false

true to fill in each recipient's variables from their Mixmax contact data. Variables you send take precedence.

boolean
Defaults to false

true to add recipients even when they lack values for variables the sequence uses.

Responses

403

You don't have the sequence activation feature. The body is empty.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!