Sign in
Mailbox API

Reschedule or cancel a saved draft send

Changed on
patch/mailbox/drafts/{draftId}/schedule

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read, email.send)

Path parameters

draftIdstring required

Stable draft ID.

Query parameters

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Headers

If-Matchstring

Current draft ETag; both revision and schedule version remain required.

Request body

expected_revisioninteger required

Exact saved content revision.

expected_schedule_versioninteger required

Current schedule version; stale requests return conflict. Repeating the last identical request returns its current result.

scheduled_forstring date-time nullable required

New future time within 30 days, or null to cancel and make the draft editable. Cancellation fails once sending has begun.

Response

Saved draft and its revision.

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes