Enviar e-mail transacional

Envia um e-mail transacional (redefinição de senha, recibo, aviso) pelo domínio verificado do workspace. Autenticação por chave de API com a permissão email:send (Authorization: Bearer wsk_...). Nada é registrado no inbox e nenhum lead ou contato é criado; cada destinatário aparece no registro de envios e nos webhooks.

Destinatários. to (ao menos um), cc e bcc, até 50 no total; endereços repetidos contam uma vez. Cada destinatário recebe a própria cópia, endereçada a ele, e é cobrado como um e-mail (mesmo preço de GET /email/pricing, mais os blocos de 256 KB dos anexos). Nenhum destinatário vê os outros.

Conteúdo. subject mais html e/ou text, ou design_id (um modelo salvo) com variables (usadas como {{field.chave}} no modelo; {{email}} vira o destinatário). from é o id ou o endereço de um remetente verificado do workspace. reply_to (até 5) vira o Reply-To; sem ele, as respostas vão para o endereço de from. headers aceita X-* (exceto X-SES-*), List-Unsubscribe, List-Unsubscribe-Post, List-Id, Auto-Submitted, Precedence e Entity-Ref-ID, até 20. tags (até 10, name e value com letras, números, _ e -) servem de filtro no registro e voltam nos webhooks. attachments: filename mais content em base64 ou path https, até 16 MB no total; executáveis e scripts são recusados.

Idempotência. idempotency_key é obrigatória (ou no cabeçalho Idempotency-Key). A mesma chave com a mesma requisição devolve o mesmo resultado (200, repeated: true) sem enviar nem cobrar de novo; destinatários que não saíram são tentados outra vez. A mesma chave com outra requisição responde 409 email_idempotency_key_reused. Uma chamada simultânea com a mesma chave responde 409 email_send_in_progress.

Resposta. 201 quando ao menos um destinatário saiu, com o resultado de cada um (status sent, ou refused com error_code). Quando nenhum saiu, a recusa do primeiro destinatário. Antes de cobrar: 400 email_idempotency_key_required, email_idempotency_key_invalid, email_from_required, email_recipients_invalid, email_address_invalid, email_reply_to_invalid, email_tags_invalid, invalid_body; 404 email_design_not_found; 409 email_idempotency_key_reused, email_send_in_progress, email_sender_not_verified, email_recipient_suppressed; 413 email_attachment_too_large; 422 email_sender_unknown, email_header_not_allowed, email_message_invalid, email_subject_invalid, email_attachment_invalid, email_attachment_blocked, email_attachment_unavailable; 402 email_balance_insufficient (details.missing_micros); 503 email_charge_failed. Depois de cobrar, com reembolso de quem não saiu: 409 email_sender_missing, email_account_paused; 429 email_daily_cap_reached; 429 email_send_throttled (cabeçalho Retry-After e details.retry_after_seconds; repita com a mesma chave); 503 email_account_reactivation_failed; 502 email_send_failed. Autenticação: 401 api_key_missing, api_key_invalid, api_key_revoked; 403 api_key_scope_missing; 429 api_key_rate_limited; 503 api_key_unavailable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Remetente, destinatários, conteúdo e chave de idempotência

attachments
array of objects
attachments
bcc
array of strings
bcc
cc
array of strings
cc
string
string
headers
object
string
string
reply_to
array of strings
reply_to
string
tags
array of objects
tags
string
to
array of strings
to
variables
object
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json