/messages

Returns messages (emails) that are in draft, have been scheduled to send, or have been sent.

"Messages" represent emails sent via Mixmax that are sent using the Mixmax compose window or automatically using the Sequences feature.

Messages can be in the following states:

  • Draft: If the message has the body property but not sendingError, then it's still in draft and hasn't been sent.
  • Attempted to send but with error: If the message has the the sendingError property but not sent property.
  • Sent: If the message has the sent property, then it has been successfully sent.
  • Scheduled: If the message has the scheduled property, then it is scheduled to send at that timestamp.

Parameter

Type

Description

_id

String

Unique ID

userId

String

Your user id

created

Timestamp

When the message was first created as a draft

updatedAt

Timestamp

When the message was last modified (usually when it was last saved as a draft)

from

Object

"From" address. This is one of your email addresses.

from.email

String

Email of 'from' address

from.name

String

Name of 'from' address

from.isDelegated

Boolean

True if this message is set to send from another user who has delegated sending access

to

Array

Recipients of message in the 'to' field

to.email

String

Email of the 'to' address

to.name

String

Name of the 'to' address, if it exists

cc

Array

Recipients of message in the 'cc' field, if specified

cc.email

String

Email of the 'cc' address

cc.name

String

Name of the 'cc' address, if it exists

bcc

Array

Recipients of message in the 'bcc' field, if specified

bcc.email

String

Email of the 'bcc' address

bcc.name

String

Name of the 'bcc' address, if it exists

subject

String

Subject of the message

trackingEnabled

Boolean

True if email tracking is enabled for this message

linkTrackingEnabled

Boolean

True if this message has link tracking enabled

fileTrackingEnabled

Boolean

True if this message has file tracking enabled

notificationsEnabled

Boolean

True if this message has "Desktop notifications" enabled

teamIds

Array

Array of team ids that email tracking results are synced to

followUp

Object

Exists if a reminder was set for this message

followUp.unparsedDate

String

Text that was typed into the date field, e.g. "In 2 days"

followUp.trigger

String

One of noReply, notRead, or regardless

followUp.description

String

Note for the followup, if there was one

attachments

Array

Array of "traditional" attachments

attachments.name

String

Filename of the attachment

attachments.type

String

Mimetype of the attachment, if known.

attachments.size

Number

The size of the file in bytes, if known.

snippetIds

Array

Array of snippet (template) ids that were used in this message.

sequence

Object

If this message was sent automatically as a sequence, this will have details about that sequence.

sequence.id

String

ID of the sequence that triggered this message

sequence.stageId

String

ID of the sequence stage that triggered this message

sequence.recipientId

String

ID of the sequence recipient that triggered this message

body

String

HTML body of the message. Won't exist if sent property exists, as Mixmax forgets about the message body after it is sent.

userHasModified

Boolean

True if the user has edited message. False if message was created and the user hasn't started typing yet, or if the message was created via automated means such as Mixmax Rule. Defaults to false.

scheduled

Timestamp

If this message is scheduled to send (and has not send yet), this is the timestamp of when it will send.

sent

Timestamp

Date the message was sent successfully. If this exists, you can assume the message was sent properly.

sendingError

String

Indicates that the message failed to send.

errorResponse

String

Will exist only if sendingError exists. Contains the raw error response from the SMTP server, if the error was due to a SMTP failure.

Language
Authentication
Header
Click Try It! to start a request and see the response here!