/sequences/:id/recipients

post

https://api.mixmax.com/v1/sequences/{id}/recipients/

Adds new recipients to a Sequence.

Path Params

string

required

The ID of the Sequence you'd like to add the user to.

Body Params

recipients

array of objects

required

Array of recipients to add. See below for object structure.

recipients*

scheduledAt

date-time

Defaults to (current time)

The unix timestamp, in milliseconds, that you'd like the Sequence to activate at for recipients (in this request - see above parameter). Set to the current time to send immediately. If set to special value false, then the recipient will be kept in draft. Note that this can be overridden for each recipient by passing scheduledAt for that recipient.

enrich

boolean

If true, passed recipients will have its variables filled up with the contact data stored in Mixmax. Any variable explicitly set as part of the request payload will take precedence over the Mixmax contact metadata.

allowMissingVariables

boolean

Defaults to false

If true, passed recipients will be added to the sequence even if they are missing variables that already exist in the sequence.

Response

Language

Credentials

Header

Request

Response

Choose an example:

application/json

200200