/snippets/:id/send

Sends an email from a template, right away unless you pass scheduledAt. You only need read access to the template.

Template variables are filled in from the first to recipient's contact, your name, signature and calendar link, and then the variables you pass, which take precedence. If any variable is left without a value the email is not sent and you get 400 with their names. Tracking and CRM logging follow your Mixmax settings unless you set them here. If you leave out cc or bcc, the template's own cc and bcc are used.

The response has no body, so it does not return the new message's id. To find it, list your messages with GET /v1/messages.

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

The template's _id.

Body Params
to
array of objects
required
length ≥ 1

The recipients. Send an array; a single object is rejected with 400.

to*
string
required
string
cc
array of objects | null

At least one recipient if sent. If you leave it out or send null, the template's own cc is used; it cannot be removed for one send. An empty array is rejected.

cc
string
required
string
bcc
array of objects | null

At least one recipient if sent. If you leave it out or send null, the template's own bcc is used; it cannot be removed for one send. An empty array is rejected.

bcc
string
required
string
string

Defaults to the template's subject.

variables
object

Values for template variables, by name. These win over automatic values.

int64

When to send, in Unix milliseconds. Must be in the future. Leave out to send now.

boolean
boolean
boolean
boolean
Responses
204

The email was sent or scheduled.

404

The template does not exist, is trashed or archived, or you cannot access it. The body is empty.

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