Update Draft
Update fields on an existing draft.
PATCH
Send at least one of
to, cc, bcc, subject, text, html, or
attachments. An empty body is rejected even when the draft already has files.
After the update, the draft must still contain at least one non-empty field.
Files already on the draft count toward that, so clearing the other fields
while leaving attachments out is allowed. Combined recipients cannot exceed 50.
Fields you leave out stay as they are. html and text are the exception:
sending either one replaces both, and the one you leave out is saved as null.
For attachments, a present array replaces the files, [] removes them, and
leaving the field out keeps them.
Path Parameters
Body Parameters
string | string[] | null
Recipients. Pass
null to clear.string | string[] | null
CC recipients. Pass
null or [] to clear.string | string[] | null
BCC recipients. Pass
null or [] to clear.string | null
The subject. Pass
null to clear. Max 2000 characters.string | null
The HTML body. Pass
null to clear. Sending html or text replaces both,
and the one you leave out is saved as null.string | null
The plain-text body. Pass
null to clear. Sending html or text replaces
both, and the one you leave out is saved as null.array
Filename and content of attachments (max 25MB of content). Each file is raw
content. path and content_id return 422. An empty file returns 422.
A present array replaces the files on the draft. [] removes them. Leave the
field out to keep the current files.Response Fields
string
Always
inbox_draft.string
The ID of the draft.
string
standalone for a new conversation, or reply.string[] | null
Recipients.
string[]
CC recipients.
string[]
BCC recipients.
string | null
The subject.
string | null
The HTML body.
string | null
The plain-text body.
string | null
The Thread ID when this draft is a reply.
null otherwise.string | null
The Email ID being replied to.
null otherwise.string | null
The queued outbound email after send.
null until then.string
ISO 8601 timestamp when the draft was created.
string
ISO 8601 timestamp when the draft was last saved.
array
The files saved on the draft.