{"_id":"5a1e658ba2d890001271035e","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":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-29T07:45:15.167Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"patch","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5a1e658ba2d8900012710360","ref":"","in":"body","required":false,"desc":"Recipients of message in the 'to' field","default":"","type":"array_object","name":"to"},{"_id":"5a1e658ba2d890001271035f","ref":"","in":"body","required":false,"desc":"Email of the 'to' address","default":"","type":"string","name":"to.email"},{"_id":"5a1f9c3aade2810012c5c50c","ref":"","in":"body","required":false,"desc":"Name of the 'to' address, if it exists","default":"","type":"string","name":"to.name"},{"_id":"5a1f9c3aade2810012c5c50b","ref":"","in":"body","required":false,"desc":"Recipients of message in the 'cc' field, if specified","default":"","type":"array_object","name":"cc"},{"_id":"5a1f9c3aade2810012c5c50a","ref":"","in":"body","required":false,"desc":"Email of the 'cc' address","default":"","type":"string","name":"cc.email"},{"_id":"5a1f9c3aade2810012c5c509","ref":"","in":"body","required":false,"desc":"Name of the 'cc' address, if it exists","default":"","type":"string","name":"cc.name"},{"_id":"5a1f9c3aade2810012c5c508","ref":"","in":"body","required":false,"desc":"Recipients of message in the 'bcc' field, if specified","default":"","type":"array_object","name":"bcc"},{"_id":"5a1f9c3aade2810012c5c507","ref":"","in":"body","required":false,"desc":"Email of the 'bcc' address","default":"","type":"string","name":"bcc.email"},{"_id":"5a1f9c3aade2810012c5c506","ref":"","in":"body","required":false,"desc":"Name of the 'bcc' address, if it exists","default":"","type":"string","name":"bcc.name"},{"_id":"5a1f9c3aade2810012c5c505","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"subject"},{"_id":"5a1f9c3aade2810012c5c504","ref":"","in":"body","required":false,"desc":"HTML body of the message","default":"","type":"string","name":"body"},{"_id":"5a1f9c3aade2810012c5c503","ref":"","in":"body","required":false,"desc":"True if email tracking is enabled for this message","default":"false","type":"boolean","name":"trackingEnabled"},{"_id":"5a1f9c3aade2810012c5c502","ref":"","in":"body","required":false,"desc":"True if this message has link tracking enabled","default":"false","type":"boolean","name":"linkTrackingEnabled"},{"_id":"5a1f9c3aade2810012c5c501","ref":"","in":"body","required":false,"desc":"True if this message has \"Desktop notifications\" enabled","default":"false","type":"boolean","name":"notificationsEnabled"},{"_id":"5a1f9c3aade2810012c5c500","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"}],"url":"/v1/messages/:id"},"isReference":true,"order":68,"body":"","excerpt":"Updates a message","slug":"messagesid-1","type":"endpoint","title":"/messages/:id"}

patch/messages/:id

Updates a message

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

to:
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 objects
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 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).

User Information

Try It Out

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