Schedule a message
/api/v1/messages/scheduledAccepts a message now and submits it at send_at. The body is exactly POST /messages,
plus send_at.
It is a separate endpoint, and that is deliberate. Other providers put the delivery time
on the send call, and the cost of that is a send endpoint whose response is a message on one
call and a schedule on the next — two object types from one operation. Here you get a
message from /messages and a scheduled_message from /messages/scheduled, always.
POST /messages refuses a send_at rather than ignoring it: a scheduling parameter
that is silently dropped delivers the message immediately, to everyone, at the wrong time,
with nothing said.
Everything that can be checked now is checked now — the body, the recipients, the
attachments, the limits, and that from is a verified Sender of yours. A scheduled send
that fails validation three days later is a message that silently never went, and you find
out from the recipient.
Suppression and rate limits are checked when it leaves, not when you schedule it. They
are questions about the world at the moment of delivery: somebody who unsubscribes on
Tuesday must not receive a message you scheduled on Monday. When that happens the row ends
failed with failure_reason set, so it says what happened rather than disappearing.
send_at must be at least 60 seconds ahead — the sweep runs every minute and we will not
promise a precision we do not have — and at most 30 days, because the whole message,
attachments included, is stored here until it goes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Idempotency-Key | header | string | Makes this request safe to retry. Use <app>-<ULID>, such as crm-01JBT8XQ2M9WYC3K4F6R7S8T9V; any other shape is a 422. Send the same key on every retry: a repeat gets the first answer with Idempotency-Replayed: true, a key reused for a different request is a 422, and one still running is a 409 with Retry-After. Keys last 24 hours, per organization. |
Request body
send_atstringrequiredWhen to send, in ISO 8601 with a time zone. At least 60 seconds and at most 30 days ahead. A time in the past is refused.
Request
/api/v1/messages/scheduledcurl -X POST 'https://app.mailyte.com/api/v1/messages/scheduled' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"to": [
"ada@example.com"
],
"from": "hello@yourdomain.com",
"subject": "Your weekly summary",
"text": "Here is what happened this week.",
"send_at": "2026-09-21T09:00:00Z"
}'const response = await fetch('https://app.mailyte.com/api/v1/messages/scheduled', {
method: 'POST',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"to": [
"ada@example.com"
],
"from": "hello@yourdomain.com",
"subject": "Your weekly summary",
"text": "Here is what happened this week.",
"send_at": "2026-09-21T09:00:00Z"
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/messages/scheduled",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"to": [
"ada@example.com"
],
"from": "hello@yourdomain.com",
"subject": "Your weekly summary",
"text": "Here is what happened this week.",
"send_at": "2026-09-21T09:00:00Z"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->post('https://app.mailyte.com/api/v1/messages/scheduled', [
'to' => [
'ada@example.com',
],
'from' => 'hello@yourdomain.com',
'subject' => 'Your weekly summary',
'text' => 'Here is what happened this week.',
'send_at' => '2026-09-21T09:00:00Z',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/messages/scheduled")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"to": [
"ada@example.com"
],
"from": "hello@yourdomain.com",
"subject": "Your weekly summary",
"text": "Here is what happened this week.",
"send_at": "2026-09-21T09:00:00Z"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
201 with the `scheduled_message`. Use its `id` to list, inspect or cancel it.
dataobjectA message accepted now and submitted at
send_at. It is not amessage: a message has left, and this has not. Once it goes,message_idnames the message it became.objectstringscheduled_messageidstringAddress this with
GETandDELETE /messages/scheduled/{id}. It identifies the SCHEDULE, not the message — seemessage_id.statusstringscheduled | sending | sent | cancelled | failedscheduled(waiting),sending(going out now; it can no longer be cancelled),sent,cancelledorfailed.modestringlive | testtestwhen a test API key scheduled this message: when it is due it is stored in your Sandbox, never delivered. Otherwiselive.send_atstringWhen it will be sent, to the minute.
fromstringThe sender, as scheduled.
toarray<string>The recipients, as scheduled.
ccandbccare held but not published back — a Bcc that reappears in a readable response is a Bcc that leaked.subjectstringnullMEANS NONE WAS SET — a message may legitimately have no subject, and a template supplies its own at render time.message_idstringThe Message-ID it was sent with. Null until it is sent, and for a cancelled or failed message.
sent_atstringWhen it was submitted.
nullMEANS IT HAS NOT BEEN.cancelled_atstringWhen it was cancelled.
nullMEANS IT WAS NOT.failure_reasonstringWhy it could not be sent. Set only when
statusisfailed. Suppression and rate limits are checked when the message is sent, not when it was scheduled.created_atstringWhen it was accepted.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.