Reschedule a message
PATCH
/messages/{id}Moves a scheduled send to another time, or sends it now.
Needs the permissionmessages:reschedule
Only while the message is still waiting. Once it has started to go there’s nothing to move, and the answer is 409 already_sent rather than a pretend success.
Path parameters
idstringrequired- The scheduled message.
Body
sendAtstringoptional- A new time in the future, as ISO 8601.
sendNowbooleanoptionaltrueto stop waiting and send it. Send one of the two.
Returns
messageIdstring- The message.
statusstringscheduled, orqueuedaftersendNow.scheduledAtstring or null- The new time. Null after
sendNow.
Errors
400bad_send_atsendAtisn’t an ISO 8601 time.400send_at_in_pastsendAthas already passed.400nothing_to_change- Neither
sendAtnorsendNow: truewas sent. 401invalid_key- The key is wrong, expired or revoked. With no Authorization header at all, the code is
missing_credentials. 403missing_scope- The key doesn’t have
messages:reschedule. TheX-Required-Scopeheader names what’s missing. 404not_found- There’s no such message, or it isn’t waiting to go.
409already_sent- It has started to go and can’t be changed.
429rate_limited- More than 120 requests a minute from this key. Wait for
Retry-Afterseconds.