/messages

post

https://api.mixmax.com/v1/messages

Creates a draft message (an email). This does not send it; use POST /v1/messages/{id}/send to send it or POST /v1/messages/{id}/schedule to schedule it.

The response is the stored message, which includes some fields that the other message endpoints do not return.

If you leave out from, the message is sent from your account's address. If you leave out trackingEnabled or smartFollowupsEnabled, your default settings apply when the draft is opened in the Mixmax compose window.

Unless your workspace turned it off, Mixmax may append a "Sent with Mixmax" line to body, depending on your plan and your "Sent with Mixmax" preference.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Boolean fields accept true or the string "true"; anything else is stored as false. Fields not listed are ignored.

array of objects

Recipients in the "To" field. Must be an array.

array of objects

Recipients in the "Cc" field. Must be an array.

bcc

array of objects

Recipients in the "Bcc" field. Must be an array.

bcc

subject

string

The subject.

body

string

The HTML body.

from

object

The sender. Defaults to your account's address and name.

trackingEnabled

boolean

Whether opens are tracked.

linkTrackingEnabled

boolean

Whether link clicks are tracked.

fileTrackingEnabled

boolean

Whether file downloads are tracked.

notificationsEnabled

boolean

Whether you get desktop notifications for this message's activity.

smartFollowupsEnabled

boolean

Whether smart follow-ups are on for this message.

showContentTeamFeed

boolean

Whether teammates can see the message content in the team live feed.

syncToOrg

boolean

Whether the message is shared to the team live feed.

inReplyTo

string

For a reply, the Gmail message id of the message being answered. On create, Mixmax fetches that message to add the quoted text and threading headers. Set subject to match the thread.

followUp

object

A reminder to follow up on this message.

attachments

array of objects

File attachments.

attachments

snippetIds

array of strings

Ids of the templates used in this message.

snippetIds

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200The draft was created. The body is the stored message.

400The message is not valid: it has more than 100 unique recipients across to, cc and bcc, or a recipient address is not valid.

403The request used an admin-managed API key. This endpoint accepts only personal API tokens. A key limited to specific scopes is refused with This API does not support scoped credentials, and a key with the * scope with This API does not support managed API credentials yet.

500The draft could not be created. This includes a from.email that is not a valid address (Email address is not valid) and a to, cc or bcc that is not an array.