Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Cabeçalhos

Idempotency-Key
string

Chave única para evitar envio duplicado. Alternativa: x-idempotency-key.

x-idempotency-key
string

Chave única para idempotência (alternativa a Idempotency-Key).

Corpo

application/json

Pelo menos um de text ou html é obrigatório.

to
string[]
obrigatório

Lista de endereços de e-mail dos destinatários. Um e-mail por endereço.

Required array length: 1 - 500 elements
Minimum string length: 1
type
enum<string>
obrigatório

Tipo do envio: email (conteúdo em payload) ou template (template do workspace em payload.templateId).

Opções disponíveis:
email,
template
payload
object
obrigatório

Corpo conforme type. email: subject (obrigatório) e text e/ou html. template: templateId e variables opcionais.

from
string
obrigatório

Endereço do remetente (e-mail verificado no workspace).

cc
string[]

Destinatários em cópia (CC). Quem recebe vê os outros destinatários do e-mail. Com cc ou bcc, todos recebem um único e-mail; sem cópias, cada endereço em to gera um envio separado.

Minimum string length: 1
bcc
string[]

Destinatários em cópia oculta (BCC). Os demais destinatários não veem quem está em BCC.

Minimum string length: 1
replyTo
string[]

Para onde vão as respostas quando o destinatário clica em Responder. Útil quando from é noreply@.

Minimum string length: 1
variables
object

Placeholders na raiz (ex.: {{name}} no assunto ou corpo). Mesclado com dados do contato do CRM.

localization
object

Localização de assunto e corpo por destinatário.

i18n
object

Traduções manuais por locale quando localization.mode é manual.

perRecipientSubjects
object

Assunto por destinatário (chave = e-mail em to). Sobrescreve o assunto base após localização.

perRecipientHtml
object

HTML por destinatário (chave = e-mail em to). Sobrescreve o HTML base após localização.

headers
object

Opcional. Cabeçalhos MIME para threading ou referência. Permitidos: In-Reply-To, References, Message-ID, X-Entity-Ref-ID (strings não vazias, máx. 2000 caracteres cada).

attachments
object[]

Anexos opcionais (máx. 10; ~30MB no total). Cada item exige filename e exatamente um de content (base64) ou path (URL HTTPS pública). contentType é opcional.

Maximum array length: 10
schedule
object
options
object
metadata
object

Metadados persistidos em Email.metadata (pares string→string). Respeite limites de payload.

listUnsubscribe
boolean
padrão:true

RFC 8058: injeta headers List-Unsubscribe e List-Unsubscribe-Post quando o destinatário resolve para um contato do workspace. Use false em e-mails transacionais.

listUnsubscribeTopicId
string

Opcional. ID do tópico de comunicação para one-click scoped (unsubscribe só daquele tópico).

fromName
string

Opcional. Nome exibido quando from é só o endereço de e-mail.

Resposta

E-mail(s) aceito(s). Enfileirado(s) para envio imediato ou agendado.

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório