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.

from
string
obrigatório

Endereço do remetente (ex.: noreply@seudominio.com). O domínio deve estar verificado no workspace.

Minimum string length: 1
to
string[]
obrigatório

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

Required array length: 1 - 100 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

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

fromName
string

Nome exibido do remetente (opcional).

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

Resposta

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

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório