Mailbox API

Edit a saved draft

Changed on
patch/mailbox/drafts/{draftId}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}
  • 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, mailbox.drafts.write)

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; expected_revision is also required.

Request body

custom_headersobject

Custom X- headers preserved with this revision.

expected_revisioninteger required

The revision that was reviewed; a stale value returns conflict.

html_bodystring

HTML body, preserved when saved.

subjectstring

Subject; may be empty.

text_bodystring

Plain-text body.

Response

Saved draft and its revision.

oktrue required

Example response

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

Changes