Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

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

POST/inboxes/{inbox_id}/drafts/{draft_id}/send
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

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

draft_idstring<uuid>erforderlich
Header-Parameter
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.

min. Länge 1 · max. Länge 256
Request-Body
application/json
headersany

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

Antworten
200

Sent

idstring<uuid>erforderlich

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

thread_idstring<uuid> | nullerforderlich

BillionSend extension: the thread the email was sent in

202

Held for approval

objectstringerforderlich
Erlaubt:inbox_draft
idstring<uuid>erforderlich
typestringerforderlich
Erlaubt:standalonereply
tostring[] | nullerforderlich
ccstring[]erforderlich
bccstring[]erforderlich
subjectstring | nullerforderlich
htmlstring | nullerforderlich
textstring | nullerforderlich
thread_idstring<uuid> | nullerforderlich
reply_to_email_idstring<uuid> | nullerforderlich
email_idstring<uuid> | nullerforderlich
created_atstringerforderlich
updated_atstringerforderlich
attachmentsobject[]erforderlich

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

Eigenschaften anzeigen
Array von object
idstringerforderlich
filenamestringerforderlich
content_typestringerforderlich
sizeintegererforderlich
statusstringerforderlich
Erlaubt:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]erforderlich
forwardbooleanerforderlich
decided_bystring | nullerforderlich
decided_atstring | nullerforderlich
expires_atstring | nullerforderlich
send_atstring | nullerforderlich

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

send_errorstring | nullerforderlich

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

400

Malformed JSON body

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
409

Idempotency conflict, or a draft already sent

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
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)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://api.billionsend.com/inboxes/string/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "headers": null
}'
Antwort
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

War diese Seite hilfreich?