Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Create a draft

A standalone draft, or with thread_id and reply_to_email_id a reply draft in that thread. One unsent reply draft per email: creating another answers 200 with the existing one. A reply draft copies no recipients; set to before sending. attachments are kept encrypted with the draft until it is sent, rejected, expired or deleted. Nothing is sent until POST /inboxes/{inbox_id}/drafts/{draft_id}/send, or until send_at (BillionSend extension) when it is given: the draft is then sent as the caller at that time, through every rule and limit, and must have a recipient. With send_at, a reply draft for an email that already has one answers 409 instead of the existing draft.

POST/inboxes/{inbox_id}/drafts
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

Request body
application/json
tostring | string[] | null

An address or a list of them; "Name <address>" works too

Show properties
Any of:
string
string
string[]
Array of string
string
null
null
ccstring | string[] | null

An address or a list of them; "Name <address>" works too

Show properties
Any of:
string
string
string[]
Array of string
string
null
null
bccstring | string[] | null

An address or a list of them; "Name <address>" works too

Show properties
Any of:
string
string
string[]
Array of string
string
null
null
subjectstring | null
htmlstring | null
textstring | null
attachmentsobject[] | null

Files with base64 content (no remote paths), 10 MiB decoded in all; none on the shared domain. A held send keeps them with its draft

Show properties
Array of object
filenamestring | boolean | null
Show properties
Any of:
string
string
boolean
boolean
null
null
contentstring
content_typestring
content_idstring

Inline part: the HTML shows it with <img src="cid:<content_id>">

min length 1 · max length 255
pathstring
send_atstring | null

BillionSend extension: send the draft at this time, as the caller, within 30 days: an ISO 8601 datetime with offset (e.g. "2026-09-01T12:00:00Z") or a relative time like "in 2 hours". A past time sends it within a minute; null cancels. The send runs every rule and limit then; a refused one leaves the draft unsent with send_error set and fires inbox.draft.send_failed. A draft waiting for approval cannot be scheduled (409)

thread_idstring<uuid>

With reply_to_email_id: a reply draft in this thread

reply_to_email_idstring<uuid>

The email of the thread the draft answers

Responses
200

The existing reply draft

objectstringrequired
Allowed:inbox_draft
idstring<uuid>required
typestringrequired
Allowed:standalonereply
tostring[] | nullrequired
ccstring[]required
bccstring[]required
subjectstring | nullrequired
htmlstring | nullrequired
textstring | nullrequired
thread_idstring<uuid> | nullrequired
reply_to_email_idstring<uuid> | nullrequired
email_idstring<uuid> | nullrequired
created_atstringrequired
updated_atstringrequired
attachmentsobject[]required

The draft's files, by position; empty once it is sent, rejected or expired

Show properties
Array of object
idstringrequired
filenamestringrequired
content_typestringrequired
sizeintegerrequired
statusstringrequired
Allowed:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]required
forwardbooleanrequired
decided_bystring | nullrequired
decided_atstring | nullrequired
expires_atstring | nullrequired
send_atstring | nullrequired

BillionSend extension: when the scheduled send goes out; null when not scheduled

send_errorstring | nullrequired

BillionSend extension: the error name of the last scheduled send that was refused (e.g. invalid_api_key, inbox_send_cap_reached, not_found); null otherwise

201

Created

objectstringrequired
Allowed:inbox_draft
idstring<uuid>required
typestringrequired
Allowed:standalonereply
tostring[] | nullrequired
ccstring[]required
bccstring[]required
subjectstring | nullrequired
htmlstring | nullrequired
textstring | nullrequired
thread_idstring<uuid> | nullrequired
reply_to_email_idstring<uuid> | nullrequired
email_idstring<uuid> | nullrequired
created_atstringrequired
updated_atstringrequired
attachmentsobject[]required

The draft's files, by position; empty once it is sent, rejected or expired

Show properties
Array of object
idstringrequired
filenamestringrequired
content_typestringrequired
sizeintegerrequired
statusstringrequired
Allowed:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]required
forwardbooleanrequired
decided_bystring | nullrequired
decided_atstring | nullrequired
expires_atstring | nullrequired
send_atstring | nullrequired

BillionSend extension: when the scheduled send goes out; null when not scheduled

send_errorstring | nullrequired

BillionSend extension: the error name of the last scheduled send that was refused (e.g. invalid_api_key, inbox_send_cap_reached, not_found); null otherwise

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key, the inbox's or the shared domain's rules, or held mail

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
409

Idempotency conflict, or a draft already sent

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

The inbox's daily send limit, or the team's daily limit for mail from the shared domain, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.billionsend.com/inboxes/string/drafts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "string",
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "html": "string",
  "text": "string",
  "attachments": [
    {
      "filename": "string",
      "content": "string",
      "content_type": "string",
      "content_id": "string",
      "path": "string"
    }
  ],
  "send_at": "string",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  "reply_to_email_id": "5e00f13a-4994-422b-8a76-6ae8ac072852"
}'
Response
{
  "object": "inbox_draft",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "standalone",
  "to": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "subject": "string",
  "html": "string",
  "text": "string",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  "reply_to_email_id": "5e00f13a-4994-422b-8a76-6ae8ac072852",
  "email_id": "8e6bf5ae-e456-4654-87f8-33e2156caffc",
  "created_at": "string",
  "updated_at": "string",
  "attachments": [
    {
      "id": "string",
      "filename": "string",
      "content_type": "string",
      "size": 0
    }
  ],
  "status": "draft",
  "approval_reasons": [
    "string"
  ],
  "forward": true,
  "decided_by": "string",
  "decided_at": "string",
  "expires_at": "string",
  "send_at": "string",
  "send_error": "string"
}

Was this page helpful?