Send a draft
Sends the draft from the inbox address; the body is optional and only ever holds headers, which are not supported (an empty value is fine), and an Idempotency-Key is accepted. Answers the sent email’s id. A draft waiting for approval goes out only when a person or a team-wide full access key sends it (403 approval_required otherwise), and their send skips the inbox’s rules but never the team’s limits or the shared domain’s rules. An agent’s send of a draft runs the rules and may hold it (202).
/inboxes/{inbox_id}/drafts/{draft_id}/sendAuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
inbox_idstringerforderlichThe inbox ID or its email address, such as support@example.com
draft_idstring<uuid>erforderlichIdempotency-Keystring1 to 256 characters. A retry with the same key and the same body answers the original response instead of sending again; the same key with a different body answers 409 invalid_idempotent_request.
application/jsonheadersanyNot supported: only an empty value is accepted, anything else answers 422
Sent
idstring<uuid>erforderlichThe ID of the sent email: GET /emails/{id} reads it
thread_idstring<uuid> | nullerforderlichBillionSend extension: the thread the email was sent in
Held for approval
objectstringerforderlichinbox_draftidstring<uuid>erforderlichtypestringerforderlichstandalonereplytostring[] | nullerforderlichccstring[]erforderlichbccstring[]erforderlichsubjectstring | nullerforderlichhtmlstring | nullerforderlichtextstring | nullerforderlichthread_idstring<uuid> | nullerforderlichreply_to_email_idstring<uuid> | nullerforderlichemail_idstring<uuid> | nullerforderlichcreated_atstringerforderlichupdated_atstringerforderlichattachmentsobject[]erforderlichThe draft's files, by position; empty once it is sent, rejected or expired
Eigenschaften anzeigenEigenschaften ausblenden
objectidstringerforderlichfilenamestringerforderlichcontent_typestringerforderlichsizeintegererforderlichstatusstringerforderlichdraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]erforderlichforwardbooleanerforderlichdecided_bystring | nullerforderlichdecided_atstring | nullerforderlichexpires_atstring | nullerforderlichsend_atstring | nullerforderlichBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullerforderlichBillionSend 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
Malformed JSON body
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichMissing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichNot found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichIdempotency conflict, or a draft already sent
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichValidation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichThe 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)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich