Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Send a draft

Sends the draft from the inbox address; the body is optional and only ever holds headers, which are not supported yet (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
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
inbox_idstringobrigatório

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

draft_idstring<uuid>obrigatório
Parâmetros de cabeçalho
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.

comprimento mín. 1 · comprimento máx. 256
Corpo da requisição
application/json
headersany

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

Respostas
200

Sent

idstring<uuid>obrigatório

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

thread_idstring<uuid> | nullobrigatório

BillionSend extension: the thread the email was sent in

202

Held for approval

objectstringobrigatório
Valores permitidos:inbox_draft
idstring<uuid>obrigatório
typestringobrigatório
Valores permitidos:standalonereply
tostring[] | nullobrigatório
ccstring[]obrigatório
bccstring[]obrigatório
subjectstring | nullobrigatório
htmlstring | nullobrigatório
textstring | nullobrigatório
thread_idstring<uuid> | nullobrigatório
reply_to_email_idstring<uuid> | nullobrigatório
email_idstring<uuid> | nullobrigatório
created_atstringobrigatório
updated_atstringobrigatório
attachmentsobject[]obrigatório

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

Mostrar propriedades
Array de object
idstringobrigatório
filenamestringobrigatório
content_typestringobrigatório
sizeintegerobrigatório
statusstringobrigatório
Valores permitidos:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]obrigatório
forwardbooleanobrigatório
decided_bystring | nullobrigatório
decided_atstring | nullobrigatório
expires_atstring | nullobrigatório
send_atstring | nullobrigatório

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

send_errorstring | nullobrigatório

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
409

Idempotency conflict, or a draft already sent

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
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)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Corpoapplication/json
Requisição
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
}'
Resposta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

Esta página foi útil?