{"_id":"5a0f3aa78662de001225458d","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb","5a31c9409a6f2000125c079f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T19:38:15.618Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5a1a153d5c8013001e22ba1e","ref":"","in":"body","required":true,"desc":"Recipients of message in the 'to' field","default":"","type":"array_object","name":"to"},{"_id":"5a1a153d5c8013001e22ba1d","ref":"","in":"body","required":false,"desc":"Email of the 'to' address","default":"","type":"string","name":"to.email"},{"_id":"5a1a153d5c8013001e22ba1c","ref":"","in":"body","required":false,"desc":"Name of the 'to' address, if it exists","default":"","type":"string","name":"to.name"},{"_id":"5a1a153d5c8013001e22ba1b","ref":"","in":"body","required":false,"desc":"Recipients of message in the 'cc' field, if specified","default":"","type":"array_string","name":"cc"},{"_id":"5a1a153d5c8013001e22ba1a","ref":"","in":"body","required":false,"desc":"","default":"Email of the 'cc' address","type":"string","name":"cc.email"},{"_id":"5a1a153d5c8013001e22ba19","ref":"","in":"body","required":false,"desc":"","default":"Name of the 'cc' address, if it exists","type":"string","name":"cc.name"},{"_id":"5a1a153d5c8013001e22ba18","ref":"","in":"body","required":false,"desc":"Recipients of message in the 'bcc' field, if specified","default":"","type":"array_object","name":"bcc"},{"_id":"5a1a153d5c8013001e22ba17","ref":"","in":"body","required":false,"desc":"Email of the 'bcc' address","default":"","type":"string","name":"bcc.email"},{"_id":"5a1a153d5c8013001e22ba16","ref":"","in":"body","required":false,"desc":"Name of the 'bcc' address, if it exists","default":"","type":"string","name":"bcc.name"},{"_id":"5a1a153d5c8013001e22ba15","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"subject"},{"_id":"5a1a15d4cc9a7d002607e508","ref":"","in":"body","required":false,"desc":"HTML body of the message","default":"","type":"string","name":"body"},{"_id":"5a1a15d4cc9a7d002607e507","ref":"","in":"body","required":false,"desc":"True if email tracking is enabled for this message","default":"false","type":"boolean","name":"trackingEnabled"},{"_id":"5a1a15d4cc9a7d002607e506","ref":"","in":"body","required":false,"desc":"True if this message has link tracking enabled","default":"false","type":"boolean","name":"linkTrackingEnabled"},{"_id":"5a1a165692058600122d1cb9","ref":"","in":"body","required":false,"desc":"True if this message has \"Desktop notifications\" enabled","default":"false","type":"boolean","name":"notificationsEnabled"},{"_id":"5a1ce6fe983d8e0012707abd","ref":"","in":"body","required":false,"desc":"Set this to true to create a Gmail draft for the message. It isn't used for any other purpose other than syncing a Gmail draft (the name is legacy).","default":"false","type":"boolean","name":"userHasModified"},{"_id":"5a24b31dc297dc0012e52762","ref":"","in":"body","required":false,"desc":"If this message is a reply, this is the Gmail API Message ID of the message it's in response to. If you set this, you should probably also set the subject to match.","default":"","type":"string","name":"inReplyTo"}],"url":"/v1/messages"},"isReference":true,"order":66,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note that this method does not send the message (email). You'll need to use the /messages/:id/send API.\"\n}\n[/block]","excerpt":"Creates a draft Mixmax message (an email)","slug":"messages-create","type":"endpoint","title":"/messages"}

post/messages

Creates a draft Mixmax message (an email)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

to:
required
array of objects
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 of strings
Recipients of message in the 'cc' field, if specified
cc.email:
stringEmail of the 'cc' address
cc.name:
stringName of the 'cc' address, if it exists
bcc:
array of objects
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
body:
string
HTML body of the message
trackingEnabled:
booleanfalse
True if email tracking is enabled for this message
linkTrackingEnabled:
booleanfalse
True if this message has link tracking enabled
notificationsEnabled:
booleanfalse
True if this message has "Desktop notifications" enabled
userHasModified:
booleanfalse
Set this to true to create a Gmail draft for the message. It isn't used for any other purpose other than syncing a Gmail draft (the name is legacy).
inReplyTo:
string
If this message is a reply, this is the Gmail API Message ID of the message it's in response to. If you set this, you should probably also set the subject to match.

Documentation

[block:callout] { "type": "info", "body": "Note that this method does not send the message (email). You'll need to use the /messages/:id/send API." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}