Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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.

POST/inboxes/{inbox_id}/emails
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

The inbox ID or its email address, such as support@example.com

Paramètres d'en-tête
Idempotency-Keystring

1 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.

longueur min 1 · longueur max 256
Corps de la requête
requisapplication/json
tostring | string[]requis

An address or a list of them; "Name <address>" works too

Afficher les propriétés
Au moins un de :
string
string
string[]
Tableau de string
string
ccstring | string[]

An address or a list of them; "Name <address>" works too

Afficher les propriétés
Au moins un de :
string
string
string[]
Tableau de string
string
bccstring | string[]

An address or a list of them; "Name <address>" works too

Afficher les propriétés
Au moins un de :
string
string
string[]
Tableau de string
string
subjectstringrequis

1-2000 characters on one line

htmlstring

HTML body

textstring

Plain-text body

attachmentsobject[] | null

Files with base64 content (no remote paths), 10 MiB decoded in all; none on the shared domain. A held send keeps them with its draft

Afficher les propriétés
Tableau de object
filenamestring | boolean | null
Afficher les propriétés
Au moins un de :
string
string
boolean
boolean
null
null
contentstring
content_typestring
content_idstring

Inline part: the HTML shows it with <img src="cid:<content_id>">

longueur min 1 · longueur max 255
pathstring
headersany

Not supported: only an empty value is accepted, anything else answers 422

requires_approvalboolean

BillionSend extension: hold the email as a draft that a person approves (202 with the Draft)

Réponses
200

Sent

idstring<uuid>requis

The ID of the sent email: GET /emails/{id} reads it

thread_idstring<uuid> | nullrequis

BillionSend extension: the thread the email was sent in

202

Held for approval

objectstringrequis
Valeurs autorisées :inbox_draft
idstring<uuid>requis
typestringrequis
Valeurs autorisées :standalonereply
tostring[] | nullrequis
ccstring[]requis
bccstring[]requis
subjectstring | nullrequis
htmlstring | nullrequis
textstring | nullrequis
thread_idstring<uuid> | nullrequis
reply_to_email_idstring<uuid> | nullrequis
email_idstring<uuid> | nullrequis
created_atstringrequis
updated_atstringrequis
attachmentsobject[]requis

The draft's files, by position; empty once it is sent, rejected or expired

Afficher les propriétés
Tableau de object
idstringrequis
filenamestringrequis
content_typestringrequis
sizeintegerrequis
statusstringrequis
Valeurs autorisées :draftpending_approvalsentrejectedexpired
approval_reasonsstring[]requis
forwardbooleanrequis
decided_bystring | nullrequis
decided_atstring | nullrequis
expires_atstring | nullrequis
send_atstring | nullrequis

BillionSend extension: when the scheduled send goes out; null when not scheduled

send_errorstring | nullrequis

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

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key, the inbox's or the shared domain's rules, or held mail

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
409

Idempotency conflict, or a draft already sent

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
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)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/inboxes/string/emails' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "string",
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "html": "string",
  "text": "string",
  "attachments": [
    {
      "filename": "string",
      "content": "string",
      "content_type": "string",
      "content_id": "string",
      "path": "string"
    }
  ],
  "headers": null,
  "requires_approval": true
}'
Réponse
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

Cette page vous a-t-elle été utile ?