Send a batch of emails
/emails/batchAuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
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.
x-batch-validationstringstrict (default): any invalid email rejects the whole batch with that email's error, sending nothing. permissive: invalid emails are listed in errors by index and the valid ones are sent.
strictpermissiveapplication/jsonSendEmailRequestfromstringerforderlichSender, "Name <user@domain>" or bare address; the domain must be verified for the team
tostring | string[]erforderlichRecipient address or list of up to 50
Eigenschaften anzeigenEigenschaften ausblenden
stringstringstringsubjectstringerforderlichSubject line
htmlstringHTML body; at least one of html/text is required
textstringPlain-text body; at least one of html/text is required
ccstring | string[]Cc address or list
Eigenschaften anzeigenEigenschaften ausblenden
stringstringstringbccstring | string[]Bcc address or list
Eigenschaften anzeigenEigenschaften ausblenden
stringstringstringreply_tostring | string[]Reply-To address or list
Eigenschaften anzeigenEigenschaften ausblenden
stringstringstringscheduled_atstringDeliver later: ISO 8601 with offset, or relative like "in 2 hours" (an ISO 8601 datetime with offset (e.g. "2026-09-01T12:00:00Z") or a relative time like "in 5 mins", "in 2 hours", or "in 1 day"); max 30 days ahead
tagsobject[]Key/value labels attached to the email for filtering; names starting with billionsend_, in any letter case, are reserved
Eigenschaften anzeigenEigenschaften ausblenden
objectnamestringerforderlichvaluestringerforderlichtopic_idstring<uuid> | nullTopic id: recipients opted out of the topic are skipped; a send to one address that is a contact also gets that contact's unsubscribe link. A topic bound to a domain (domain_id) can be sent only from that domain (422 otherwise)
attachmentsobject[]Attachments with base64 content (no remote paths)
Eigenschaften anzeigenEigenschaften ausblenden
objectfilenamestring | boolean | nullEigenschaften anzeigenEigenschaften ausblenden
stringbooleannullcontentstringcontent_typestringcontent_idstringInline part: the HTML shows it with <img src="cid:<content_id>">
pathstringheadersobjectExtra message headers (transport headers are rejected)
templateanyNot supported: any value is a 422; an email takes html and/or text
Batch accepted
dataobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
objectidstring<uuid>erforderlicherrorsobject[]Eigenschaften anzeigenEigenschaften ausblenden
objectindexintegererforderlichmessagestringerforderlichIdempotency-Key is not 1 to 256 characters
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichMissing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichRestricted API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichNot found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichIdempotency conflict
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichValidation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichSending quota exceeded, or the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich