Edit a saved draft

curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expected_revision": 123
}
'

import requests

url = "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}"

payload = { "expected_revision": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expected_revision: 123})
};

fetch('https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}"

	payload := strings.NewReader("{\n  \"expected_revision\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "failure_code": "preparation_failed",
    "id": "<string>",
    "in_reply_to": [
      "<string>"
    ],
    "message_id": "<string>",
    "references": [
      "<string>"
    ],
    "revision": 123,
    "schedule_version": 1,
    "scheduled_for": "2023-11-07T05:31:56Z",
    "status": "preparing",
    "attachments": [
      {
        "blob_id": "<string>",
        "content_type": "<string>",
        "filename": "<string>",
        "size_bytes": 3750000,
        "content_id": "<string>",
        "disposition": "attachment"
      }
    ],
    "bcc": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "cc": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "custom_headers": {},
    "from": {
      "email": "jsmith@example.com",
      "name": "<string>"
    },
    "html_body": "<string>",
    "reply_to": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "reply_to_message_id": "<string>",
    "subject": "<string>",
    "text_body": "<string>",
    "to": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

PATCH

mailbox

drafts

{draftId}

Edit a saved draft

curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expected_revision": 123
}
'

import requests

url = "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}"

payload = { "expected_revision": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expected_revision: 123})
};

fetch('https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}"

	payload := strings.NewReader("{\n  \"expected_revision\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "failure_code": "preparation_failed",
    "id": "<string>",
    "in_reply_to": [
      "<string>"
    ],
    "message_id": "<string>",
    "references": [
      "<string>"
    ],
    "revision": 123,
    "schedule_version": 1,
    "scheduled_for": "2023-11-07T05:31:56Z",
    "status": "preparing",
    "attachments": [
      {
        "blob_id": "<string>",
        "content_type": "<string>",
        "filename": "<string>",
        "size_bytes": 3750000,
        "content_id": "<string>",
        "disposition": "attachment"
      }
    ],
    "bcc": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "cc": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "custom_headers": {},
    "from": {
      "email": "jsmith@example.com",
      "name": "<string>"
    },
    "html_body": "<string>",
    "reply_to": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ],
    "reply_to_message_id": "<string>",
    "subject": "<string>",
    "text_body": "<string>",
    "to": [
      {
        "email": "jsmith@example.com",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match

string

Current draft ETag; expected_revision is also required.

Path Parameters

draftId

string

required

Stable draft ID.

Query Parameters

mailbox_id

string

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.

Body

application/json

expected_revision

integer

required

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

attachments

object[]

Attachments and inline images.

Maximum array length: 10

Hide child attributes

attachments.blob_id

string

required

An attachment uploaded to this mailbox.

Required string length: 1 - 255

attachments.content_type

string

required

Attachment media type.

Required string length: 1 - 255

attachments.filename

string

required

Attachment filename.

Required string length: 1 - 255

attachments.size_bytes

integer

required

Attachment size in bytes; verified when saved.

Required range: 0 <= x <= 7500000

attachments.content_id

string

Content ID referenced by an inline image.

Required string length: 1 - 998

attachments.disposition

enum<string>

Whether the attachment appears within the message.

Available options:

attachment,

inline

bcc

object[]

Hidden copied recipients.

Maximum array length: 50

Hide child attributes

bcc.email

string<email>

required

Email address.

Maximum string length: 254

bcc.name

string | null

Display name.

Maximum string length: 255

object[]

Visible copied recipients.

Maximum array length: 50

Hide child attributes

cc.email

string<email>

required

Email address.

Maximum string length: 254

cc.name

string | null

Display name.

Maximum string length: 255

custom_headers

object

Custom X- headers preserved with this revision.

Hide child attributes

custom_headers.{key}

string

from

object

Authorised sender; defaults to this inbox.

Hide child attributes

from.email

string<email>

required

Email address.

Maximum string length: 254

from.name

string | null

Display name.

Maximum string length: 255

html_body

string

HTML body, preserved when saved.

Maximum string length: 1000000

reply_to

object[]

Authorised reply addresses; defaults to this inbox.

Maximum array length: 20

Hide child attributes

reply_to.email

string<email>

required

Email address.

Maximum string length: 254

reply_to.name

string | null

Display name.

Maximum string length: 255

subject

string

Subject; may be empty.

Maximum string length: 998

text_body

string

Plain-text body.

Maximum string length: 1000000

object[]

Primary recipients; at most 50 total across To, Cc and Bcc.

Maximum array length: 50

Hide child attributes

to.email

string<email>

required

Email address.

Maximum string length: 254

to.name

string | null

Display name.

Maximum string length: 255

Response

Saved draft and its revision.

Overview

Mailboxes

Session and identity

Messages

Saved drafts

Attachments

Threads

Folders

Submissions

Usage

Sync

Edit a saved draft

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response