Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

Parámetros de encabezado
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.

longitud mín. 1 · longitud máx. 256
Cuerpo de la solicitud
obligatorioapplication/json
tostring | string[]obligatorio

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

Mostrar propiedades
Al menos uno de:
string
string
string[]
Array de string
string
ccstring | string[]

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

Mostrar propiedades
Al menos uno de:
string
string
string[]
Array de string
string
bccstring | string[]

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

Mostrar propiedades
Al menos uno de:
string
string
string[]
Array de string
string
subjectstringobligatorio

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

Mostrar propiedades
Array de object
filenamestring | boolean | null
Mostrar propiedades
Al menos uno de:
string
string
boolean
boolean
null
null
contentstring
content_typestring
content_idstring

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

longitud mín. 1 · longitud máx. 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)

Respuestas
200

Sent

idstring<uuid>obligatorio

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

thread_idstring<uuid> | nullobligatorio

BillionSend extension: the thread the email was sent in

202

Held for approval

objectstringobligatorio
Valores permitidos:inbox_draft
idstring<uuid>obligatorio
typestringobligatorio
Valores permitidos:standalonereply
tostring[] | nullobligatorio
ccstring[]obligatorio
bccstring[]obligatorio
subjectstring | nullobligatorio
htmlstring | nullobligatorio
textstring | nullobligatorio
thread_idstring<uuid> | nullobligatorio
reply_to_email_idstring<uuid> | nullobligatorio
email_idstring<uuid> | nullobligatorio
created_atstringobligatorio
updated_atstringobligatorio
attachmentsobject[]obligatorio

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

Mostrar propiedades
Array de object
idstringobligatorio
filenamestringobligatorio
content_typestringobligatorio
sizeintegerobligatorio
statusstringobligatorio
Valores permitidos:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]obligatorio
forwardbooleanobligatorio
decided_bystring | nullobligatorio
decided_atstring | nullobligatorio
expires_atstring | nullobligatorio
send_atstring | nullobligatorio

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

send_errorstring | nullobligatorio

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
409

Idempotency conflict, or a draft already sent

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
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)

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
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
}'
Respuesta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

¿Te ha resultado útil esta página?