Messages

Update a scheduled message

Replace recipients, content, staged attachments, and delivery time before dispatch begins. Omitting both html and text moves the send in time and keeps the stored body, so a rich HTML send does not have to be resent to be rescheduled.

patch/scheduled-messages/{id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/scheduled-messages/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

Idempotency-Keystring

Unique key for idempotent requests. Printable ASCII, 1-255 characters. The response is cached for 24 hours. A message send also derives the message ID from the key, so after the cache expires a retry on the same endpoint returns the message already sent, without comparing the body, for as long as that message exists.

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

subjectstring required
htmlstring

HTML body. Omit both html and text to keep the scheduled draft's stored body; sending either one replaces the body as a unit.

textstring

Plain text body. Omit both html and text to keep the scheduled draft's stored body; sending either one replaces the body as a unit.

in_reply_tostring

Replaces the In-Reply-To header. The scheduled message keeps the conversation it was stored in.

referencesstring[]

Replaces the References header. It never decides or merges conversations.

staged_attachment_idsstring[]
scheduled_atstring date-time required

Response

Updated scheduled message.

object'scheduled_message' required
idstring required

Tracked message ID used by scheduled-message endpoints.

scheduled_message_idstring required

Internal scheduled lifecycle row ID.

status'scheduled' | 'settling'

scheduled while the message waits for its send time. settling when a send attempt may already have gone out and Shipmail is checking whether it did: the message cannot be updated or cancelled until that resolves, and it then leaves the scheduled list as sent, or returns as scheduled. Treat a value you do not recognize as not editable. Absent from responses of servers that predate the field; treat absence as scheduled.

kind'scheduled' | 'undo' required
mailbox_idstring required
mailbox_addressstring email required
from_addressstring email required
identity_idstring required
mode'live' | 'test' required

The API-key data plane that owns this resource. Test resources are isolated from live delivery, quota, suppression, and reputation.

subjectstring required
scheduled_atstring date-time required
created_atstring date-time required
updated_atstring date-time required
last_errorstring nullable required
draft_email_idstring
from_namestring
textstring
htmlstring
in_reply_tostring nullable
referencesstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.