Reschedule or cancel a saved draft send
curl --request PATCH \
--url https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_revision": 123,
"expected_schedule_version": 1073741823,
"scheduled_for": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule"
payload = {
"expected_revision": 123,
"expected_schedule_version": 1073741823,
"scheduled_for": "2023-11-07T05:31:56Z"
}
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,
expected_schedule_version: 1073741823,
scheduled_for: '2023-11-07T05:31:56Z'
})
};
fetch('https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule', 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}/schedule"
payload := strings.NewReader("{\n \"expected_revision\": 123,\n \"expected_schedule_version\": 1073741823,\n \"scheduled_for\": \"2023-11-07T05:31:56Z\"\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
}Saved drafts
Reschedule or cancel a saved draft send
PATCH
/
mailbox
/
drafts
/
{draftId}
/
schedule
Reschedule or cancel a saved draft send
curl --request PATCH \
--url https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_revision": 123,
"expected_schedule_version": 1073741823,
"scheduled_for": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule"
payload = {
"expected_revision": 123,
"expected_schedule_version": 1073741823,
"scheduled_for": "2023-11-07T05:31:56Z"
}
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,
expected_schedule_version: 1073741823,
scheduled_for: '2023-11-07T05:31:56Z'
})
};
fetch('https://app.sendmux.ai/api/v1/mailbox/drafts/{draftId}/schedule', 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}/schedule"
payload := strings.NewReader("{\n \"expected_revision\": 123,\n \"expected_schedule_version\": 1073741823,\n \"scheduled_for\": \"2023-11-07T05:31:56Z\"\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
bearerAuthoauth2
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
Current draft ETag; both revision and schedule version remain required.
Path Parameters
Stable draft ID.
Query Parameters
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
Exact saved content revision.
Current schedule version; stale requests return conflict. Repeating the last identical request returns its current result.
Required range:
0 <= x <= 2147483647New 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.
Available options:
true Hide child attributes
Hide child attributes
Safe failure reason. Correct failed draft content or current permissions before retrying. Never retry an uncertain send as a new message.
Available options:
preparation_failed, authorisation_revoked, send_rejected Stable draft ID.
Snapshotted parent message identifiers.
Saved message ID; absent until saving finishes.
Snapshotted conversation identifiers.
Current draft revision.
Schedule control version. Changes whenever a schedule is created, moved or cancelled.
Required range:
x >= 0Requested earliest send time, retained after sending. Null when no schedule is set.
Saving or sending state.
Available options:
preparing, ready, scheduled, sending, queued, uncertain, failed, deleted Attachments and inline images.
Maximum array length:
10Hide child attributes
Hide child attributes
An attachment uploaded to this mailbox.
Required string length:
1 - 255Attachment media type.
Required string length:
1 - 255Attachment filename.
Required string length:
1 - 255Attachment size in bytes; verified when saved.
Required range:
0 <= x <= 7500000Content ID referenced by an inline image.
Required string length:
1 - 998Whether the attachment appears within the message.
Available options:
attachment, inline HTML body, preserved when saved.
Maximum string length:
1000000Original message this draft replies to.
Subject; may be empty.
Maximum string length:
998Plain-text body.
Maximum string length:
1000000Was this page helpful?
⌘I