Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a draft

One draft with its body, also after it was sent (status sent, email_id set).

GET/inboxes/{inbox_id}/drafts/{draft_id}
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

draft_idstring<uuid>required
Responses
200

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

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
Request
curl -X GET 'https://api.billionsend.com/inboxes/string/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
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?