Update a draft

PATCH

https://api.agentmailer.ai/v1/inboxes/:inboxId/drafts/:draftId

PATCH

/v1/inboxes/:inboxId/drafts/:draftId

$ curl -X PATCH https://api.agentmailer.ai/v1/inboxes/inboxId/drafts/draftId \
>      -H "Authorization: Bearer <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "draft": {
3     "to": [
4       "string"
5     ],
6     "attachments": [
7       {
8         "content": "string",
9         "contentId": "string",
10         "disposition": "attachment",
11         "filename": "string"
12       }
13     ],
14     "id": "string",
15     "inboxId": "string",
16     "createdAt": "2024-01-15T09:30:00Z",
17     "updatedAt": "2024-01-15T09:30:00Z",
18     "sendStatus": "scheduled",
19     "cc": [
20       "string"
21     ],
22     "bcc": [
23       "string"
24     ],
25     "replyTo": [
26       "string"
27     ],
28     "subject": "",
29     "text": "string",
30     "html": "string",
31     "headers": {},
32     "replyToMessageId": "string",
33     "forwardMessageId": "string",
34     "sendAt": "2024-01-15T09:30:00Z"
35   }
36 }

Update a draft

Authentication

AuthorizationBearer

Human-approved credential. Least-privilege grants are published in RFC 9728 protected-resource metadata and on each operation as x-required-permission.

Path parameters

inboxIdstringRequiredformat: "^inb_"

draftIdstringRequiredformat: "^drf_"

Request

This endpoint expects an object.

tolist of strings or objectsOptional

cclist of strings or objectsOptional

bcclist of strings or objectsOptional

replyTolist of strings or objectsOptional

subjectstringOptional<=998 characters

textstringOptional<=10000000 characters

htmlstringOptional<=10000000 characters

headersmap from strings to stringsOptional

attachmentslist of objectsOptional

replyToMessageIdstringOptionalformat: "^[a-z]{3}_[A-Za-z0-9]{6,}$"

forwardMessageIdstringOptionalformat: "^[a-z]{3}_[A-Za-z0-9]{6,}$"

sendAtdatetime or nullOptional

Response

Updated draft

draftobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error