/messages/:id/schedule

Schedules a saved message to send later. It moves to your Outbox, and its Gmail draft is deleted. You must be the message's sender or delegator; otherwise the response is 404.

The message is checked first: at most 100 recipients, all with valid addresses. Responses are plain text (sent as text/html), not JSON. To cancel, use DELETE on the same path.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The message's _id.

Body Params
options
object
required
data
object

Message fields to update before scheduling, as in PATCH /v1/messages/{id}.

Responses

404

The message does not exist or is not yours. The body is empty.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
text/html
Psst... like working with APIs? Come join us!