/messages/:id

patch

https://api.mixmax.com/v1/messages/{id}

Updates a message you sent or sent as a delegate. Only the fields you include change; each one replaces the stored value, so to, cc and bcc replace the whole list. Fields not listed below are ignored.

The fields you include are checked as on create: at most 100 unique recipients across the lists you send, all with valid addresses. On success the response is 204 with no body.

Send booleans as JSON true or false; this endpoint stores the value as given.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The message's _id.

Body Params

Message fields you can set when creating or updating a message.

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

The message was updated. The response has no body.

404

The message does not exist or you cannot access it. The body is empty.

Language

Credentials

Header

Loading…

Response

Choose an example:

text/html

application/json

400The new values are not valid: too many recipients or an address that is not valid. The body is plain text (sent as text/html), not JSON.

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.