Send an email from an inbox
Sends a new conversation from the inbox address in one call (to, subject, html and/or text, optional cc, bcc and attachments as POST /emails takes them). It runs the same rules as a reply: an inbox that may not start conversations, a first-time recipient past the ramp, or requires_approval: true keeps it as a draft for a person to approve and the answer is 202 with the Draft. Accepts an Idempotency-Key. An inbox on the shared domain takes no attachments.
/inboxes/{inbox_id}/emailsAuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
inbox_idstring必填The inbox ID or its email address, such as support@example.com
Idempotency-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/jsontostring | string[]必填An address or a list of them; "Name <address>" works too
显示属性隐藏属性
stringstring 数组stringccstring | string[]An address or a list of them; "Name <address>" works too
显示属性隐藏属性
stringstring 数组stringbccstring | string[]An address or a list of them; "Name <address>" works too
显示属性隐藏属性
stringstring 数组stringsubjectstring必填1-2000 characters on one line
htmlstringHTML body
textstringPlain-text body
attachmentsobject[] | 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
显示属性隐藏属性
object 数组filenamestring | boolean | null显示属性隐藏属性
stringbooleannullcontentstringcontent_typestringcontent_idstringInline part: the HTML shows it with <img src="cid:<content_id>">
pathstringheadersanyNot supported: only an empty value is accepted, anything else answers 422
requires_approvalbooleanBillionSend extension: hold the email as a draft that a person approves (202 with the Draft)
Sent
idstring<uuid>必填The ID of the sent email: GET /emails/{id} reads it
thread_idstring<uuid> | null必填BillionSend extension: the thread the email was sent in
Held for approval
objectstring必填inbox_draftidstring<uuid>必填typestring必填standalonereplytostring[] | null必填ccstring[]必填bccstring[]必填subjectstring | null必填htmlstring | null必填textstring | null必填thread_idstring<uuid> | null必填reply_to_email_idstring<uuid> | null必填email_idstring<uuid> | null必填created_atstring必填updated_atstring必填attachmentsobject[]必填The draft's files, by position; empty once it is sent, rejected or expired
显示属性隐藏属性
object 数组idstring必填filenamestring必填content_typestring必填sizeinteger必填statusstring必填draftpending_approvalsentrejectedexpiredapproval_reasonsstring[]必填forwardboolean必填decided_bystring | null必填decided_atstring | null必填expires_atstring | null必填send_atstring | null必填BillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | null必填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
Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Restricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumber必填namestring必填messagestring必填Not found
statusCodenumber必填namestring必填messagestring必填Idempotency conflict, or a draft already sent
statusCodenumber必填namestring必填messagestring必填Validation error
statusCodenumber必填namestring必填messagestring必填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)
statusCodenumber必填namestring必填messagestring必填