{"_id":"5a1e6487a2d8900012710326","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":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-29T07:40:55.477Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5a1e6487a2d8900012710327","ref":"","in":"body","required":false,"desc":"Message properties (same as https://developer.mixmax.com/docs/messages-create) to use to update the message prior to sending. This is optional. If omitted, the current saved message will be sent.","default":"{}","type":"object","name":"data"},{"_id":"5a1fa7528f8c6c0012a6d51b","ref":"","in":"body","required":true,"desc":"Sending options","default":"{}","type":"object","name":"options"},{"_id":"5a1fafb48f8c6c0012a6d5de","ref":"","in":"body","required":true,"desc":"The date to schedule the message for","default":"","type":"timestamp","name":"options.scheduledDate"}],"url":"/v1/message/:id/schedule"},"isReference":true,"order":69,"body":"","excerpt":"Schedules a message to be sent. The message will be placed in the Mixmax Outbox.","slug":"messagesidschedule","type":"endpoint","title":"/messages/:id/schedule"}

post/messages/:id/schedule

Schedules a message to be sent. The message will be placed in the Mixmax Outbox.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

data:
object{}
Message properties (same as https://developer.mixmax.com/docs/messages-create) to use to update the message prior to sending. This is optional. If omitted, the current saved message will be sent.
options:
required
object{}
Sending options
options.scheduledDate:
required
timestamp
The date to schedule the message for

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 }}