Update a draft
Each given field replaces the stored one; null clears it. Setting html or text replaces the whole body: the part left out becomes null. attachments replaces the whole list (null or an empty list removes the files). A sent draft, or one that changed during the request, answers 409. An edit by an agent sends a draft waiting for approval back to draft. send_at (BillionSend extension) schedules the draft to be sent as the caller, or reschedules it, and clears send_error; null cancels the schedule. A draft waiting for approval cannot be scheduled (409). When the scheduled send goes out, the draft becomes sent; when the inbox’s rules hold it, pending_approval; when it is refused (the key revoked, the inbox deleted, a limit reached), it stays a draft with send_at null, send_error set and an inbox.draft.send_failed webhook.
/inboxes/{inbox_id}/drafts/{draft_id}AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
draft_idstring<uuid>requiredapplication/jsontostring | string[] | nullAn address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringnullccstring | string[] | nullAn address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringnullbccstring | string[] | nullAn address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringnullsubjectstring | nullhtmlstring | nulltextstring | nullattachmentsobject[] | nullFiles 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 propertiesHide properties
objectfilenamestring | boolean | nullShow propertiesHide properties
stringbooleannullcontentstringcontent_typestringcontent_idstringInline part: the HTML shows it with <img src="cid:<content_id>">
pathstringsend_atstring | nullBillionSend 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)
Draft
objectstringrequiredinbox_draftidstring<uuid>requiredtypestringrequiredstandalonereplytostring[] | nullrequiredccstring[]requiredbccstring[]requiredsubjectstring | nullrequiredhtmlstring | nullrequiredtextstring | nullrequiredthread_idstring<uuid> | nullrequiredreply_to_email_idstring<uuid> | nullrequiredemail_idstring<uuid> | nullrequiredcreated_atstringrequiredupdated_atstringrequiredattachmentsobject[]requiredThe draft's files, by position; empty once it is sent, rejected or expired
Show propertiesHide properties
objectidstringrequiredfilenamestringrequiredcontent_typestringrequiredsizeintegerrequiredstatusstringrequireddraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]requiredforwardbooleanrequireddecided_bystring | nullrequireddecided_atstring | nullrequiredexpires_atstring | nullrequiredsend_atstring | nullrequiredBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullrequiredBillionSend 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
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredIdempotency conflict, or a draft already sent
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredThe 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)
statusCodenumberrequirednamestringrequiredmessagestringrequired