{"_id":"588a97f5ed9aa81b00afbc0d","user":"5588b847f6c18d0d005bba01","project":"5588b8a2f6c18d0d005bba03","__v":1,"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"},"parentDoc":null,"version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["59137682f865370f000b29b3"],"next":{"pages":[],"description":""},"createdAt":"2017-01-27T00:44:37.167Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"588a97f5ed9aa81b00afbc1a","ref":"","in":"body","required":true,"desc":"Attributes of the reminder to create","default":"","type":"object","name":"reminder"},{"_id":"588a97f5ed9aa81b00afbc19","ref":"","in":"body","required":true,"desc":"The name of the service e.g. 'gmail'","default":"","type":"string","name":"reminder.service"},{"_id":"588a97f5ed9aa81b00afbc18","ref":"","in":"body","required":false,"desc":"The id of the message on the service. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.","default":"","type":"string","name":"reminder.serviceMessageId"},{"_id":"588a97f5ed9aa81b00afbc17","ref":"","in":"body","required":false,"desc":"The id of the thread on the service. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.","default":"","type":"string","name":"reminder.serviceThreadId"},{"_id":"588a97f5ed9aa81b00afbc16","ref":"","in":"body","required":false,"desc":"The id of the message on Mixmax. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.","default":"","type":"string","name":"reminder.mixmaxMessageId"},{"_id":"588a97f5ed9aa81b00afbc15","ref":"","in":"body","required":true,"desc":"The trigger for the reminder. One of `noReply`, `notRead` or `regardless`. Note, `notRead` is only available when `mixmaxMessageId` is provided.","default":"","type":"string","name":"reminder.trigger"},{"_id":"588a97f5ed9aa81b00afbc14","ref":"","in":"body","required":true,"desc":"The date/time for the reminder to occur. In ms.","default":"","type":"timestamp","name":"reminder.date"},{"_id":"588a97f5ed9aa81b00afbc13","ref":"","in":"body","required":false,"desc":"Note for the reminder.","default":"","type":"string","name":"reminder.description"},{"_id":"588a97f5ed9aa81b00afbc12","ref":"","in":"body","required":false,"desc":"The subject of the thread.","default":"","type":"string","name":"reminder.threadSubject"},{"_id":"588a97f5ed9aa81b00afbc11","ref":"","in":"body","required":false,"desc":"The recipients of the message/thread.","default":"","type":"array_object","name":"reminder.recipients"},{"_id":"588a97f5ed9aa81b00afbc10","ref":"","in":"body","required":false,"desc":"The email address of the recipient.","default":"","type":"string","name":"reminder.recipients.email"},{"_id":"588a97f5ed9aa81b00afbc0f","ref":"","in":"body","required":false,"desc":"The name of the recipient.","default":"","type":"string","name":"reminder.recipients.name"},{"_id":"588a97f5ed9aa81b00afbc0e","ref":"","in":"body","required":false,"desc":"If true, archives the thread once the reminder has been created.","default":"false","type":"boolean","name":"archiveThread"}],"url":"/v1/reminders"},"isReference":true,"order":70,"body":"","excerpt":"Creates a reminder","slug":"reminders-1","type":"endpoint","title":"/reminders"}

post/reminders

Creates a reminder

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

reminder:
required
object
Attributes of the reminder to create
reminder.service:
required
string
The name of the service e.g. 'gmail'
reminder.serviceMessageId:
string
The id of the message on the service. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.
reminder.serviceThreadId:
string
The id of the thread on the service. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.
reminder.mixmaxMessageId:
string
The id of the message on Mixmax. One of `serviceMessageId`, `serviceThreadId` or `mixmaxMessageId` must be provided.
reminder.trigger:
required
string
The trigger for the reminder. One of `noReply`, `notRead` or `regardless`. Note, `notRead` is only available when `mixmaxMessageId` is provided.
reminder.date:
required
timestamp
The date/time for the reminder to occur. In ms.
reminder.description:
string
Note for the reminder.
reminder.threadSubject:
string
The subject of the thread.
reminder.recipients:
array of objects
The recipients of the message/thread.
reminder.recipients.email:
string
The email address of the recipient.
reminder.recipients.name:
string
The name of the recipient.
archiveThread:
booleanfalse
If true, archives the thread once the reminder has been created.

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