Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Unique key to prevent duplicate sends. Alternative: x-idempotency-key.

x-idempotency-key
string

Unique idempotency key (alternative to Idempotency-Key).

Body

application/json

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

from
string
required

Sender address (e.g. noreply@yourdomain.com). Domain must be verified in the workspace.

Minimum string length: 1
to
string[]
required

Recipient email addresses. One email per address.

Required array length: 1 - 100 elements
Minimum string length: 1
type
enum<string>
required

Send type: email (content in payload) or template (workspace template in payload.templateId).

Available options:
email,
template
payload
object
required

Content per type. email: subject (required) and text and/or html. template: templateId (required) and optional variables.

fromName
string

Display name of the sender (optional).

schedule
object
options
object
metadata
object

Metadata stored on Email.metadata (string→string pairs). Respect payload limits.

listUnsubscribe
boolean
default:true

RFC 8058: injects List-Unsubscribe and List-Unsubscribe-Post headers when the recipient maps to a workspace contact. Set false for transactional email.

listUnsubscribeTopicId
string

Optional. Communication topic ID for topic-scoped one-click unsubscribe.

Response

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

success
boolean
required
Example:

true

data
object
required