AGagentmail-to
InboxesDrafts

Create Draft

CLI:

agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
post/v0/inboxes/{inbox_id}/drafts

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

labelsstring[]

Labels of draft.

reply_tostring[]

Reply-to addresses. In format username@domain.com or Display Name <username@domain.com>.

tostring[]

Addresses of recipients. In format username@domain.com or Display Name <username@domain.com>.

ccstring[]

Addresses of CC recipients. In format username@domain.com or Display Name <username@domain.com>.

bccstring[]

Addresses of BCC recipients. In format username@domain.com or Display Name <username@domain.com>.

subjectstring

Subject of draft.

textstring

Plain text body of draft.

htmlstring

HTML body of draft.

in_reply_tostring

ID of message being replied to.

send_atstring date-time

Time at which to schedule send draft.

client_idstring

Client ID of draft.

Response

inbox_idstring required

The ID of the inbox.

draft_idstring required

ID of draft.

client_idstring

Client ID of draft.

labelsstring[] required

Labels of draft.

reply_tostring[]

Reply-to addresses. In format username@domain.com or Display Name <username@domain.com>.

tostring[]

Addresses of recipients. In format username@domain.com or Display Name <username@domain.com>.

ccstring[]

Addresses of CC recipients. In format username@domain.com or Display Name <username@domain.com>.

bccstring[]

Addresses of BCC recipients. In format username@domain.com or Display Name <username@domain.com>.

subjectstring

Subject of draft.

previewstring

Text preview of draft.

textstring

Plain text body of draft.

htmlstring

HTML body of draft.

in_reply_tostring

ID of message being replied to.

referencesstring[] nullable

IDs of previous messages in thread.

send_status'scheduled' | 'sending' | 'failed'

Schedule send status of draft.

send_atstring date-time

Time at which to schedule send draft.

updated_atstring date-time required

Time at which draft was last updated.

created_atstring date-time required

Time at which draft was created.

Changes

No recorded changes to this operation across all 1 revision of this API.