Skip to main content
POST
Envie um único e-mail transacional de forma assíncrona.

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Corpo

application/json
contactProperties
object
obrigatório

O campo contactProperties é um mapa de valores de propriedade do contato. Cada valor de propriedade do contato contém uma propriedade de nome e valor. Cada propriedade será definida no registro do contato e será visível no modelo em {{ contact.NAME }}. Use essas propriedades quando quiser definir uma propriedade do contato ao enviar o e-mail. Por exemplo, ao enviar um recibo, você pode querer definir uma propriedade last_paid_date, pois o envio do recibo terá informações sobre o último pagamento.

customProperties
object
obrigatório

O campo customProperties é um mapa de valores de propriedade. Cada valor de propriedade contém uma propriedade de nome e valor. Cada propriedade será visível no modelo em {{ custom.NAME }}. Observação: propriedades personalizadas atualmente não são compatíveis com matrizes. Para fornecer uma lista em um e-mail, uma solução alternativa é construir uma lista HTML (seja com tabelas ou ul) e especificá-la como uma propriedade personalizada.

emailId
integer<int64>
obrigatório

O ID de conteúdo para o e-mail transacional, que pode ser encontrado na UI da ferramenta de e-mail.

message
object
obrigatório

Resposta

successful operation

status
enum<string>
obrigatório

O status da solicitação de envio.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
statusId
string
obrigatório

O identificador usado para consultar o status do envio.

completedAt
string<date-time>

A hora em que o envio foi concluído.

eventId
object
message
string

Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado

requestedAt
string<date-time>

A hora em que o envio foi solicitado.

sendResult
enum<string>

O resultado do envio.

Opções disponíveis:
ADDRESS_LIST_BOMBED,
ADDRESS_ONLY_ACCEPTED_ON_PROD,
ADDRESS_OPTED_OUT,
ATTACHMENT_DOWNLOAD_QUEUE_FULL,
BLOCKED_ADDRESS,
BLOCKED_DOMAIN,
BRAND_RECIPIENT_FATIGUE_SUPPRESSED,
CAMPAIGN_CANCELLED,
CANCELLED_ABUSE,
CONTACT_VIEW_PERMISSION,
CORRUPT_INPUT,
EMAIL_DISABLED,
EMAIL_UNCONFIRMED,
GDPR_DOI_ENABLED,
GRAYMAIL_SUPPRESSED,
HUBL_LIMIT_EXCEEDED,
IDEMPOTENT_FAIL,
IDEMPOTENT_IGNORE,
INVALID_APP_ID_ATTRIBUTION,
INVALID_FROM_ADDRESS,
INVALID_TO_ADDRESS,
LOW_CONTACT_QUALITY_SCORE,
MARKETING_ACTIVATION_DISALLOWED,
MISSING_CONTENT,
MISSING_REQUIRED_PARAMETER,
MISSING_TEMPLATE_PROPERTIES,
MTA_IGNORE,
NON_MARKETABLE_CONTACT,
PORTAL_AUTHENTICATION_FAILURE,
PORTAL_EXPIRED,
PORTAL_MISSING_MARKETING_SCOPE,
PORTAL_NOT_AUTHORIZED_FOR_APPLICATION,
PORTAL_OVER_LIMIT,
PORTAL_SUSPENDED,
PREVIOUS_SPAM,
PREVIOUSLY_BOUNCED,
PREVIOUSLY_UNSUBSCRIBED_BRAND,
PREVIOUSLY_UNSUBSCRIBED_BUSINESS_UNIT,
PREVIOUSLY_UNSUBSCRIBED_MESSAGE,
PREVIOUSLY_UNSUBSCRIBED_PORTAL,
QUARANTINED_ADDRESS,
QUEUED,
RECIPIENT_FATIGUE_SUPPRESSED,
SENT,
TEMPLATE_RENDER_EXCEPTION,
THROTTLED,
TOO_MANY_RECIPIENTS,
UBB_GOVERNANCE_MISSING,
UNCONFIGURED_SENDING_DOMAIN,
UNDELIVERABLE,
VALIDATION_FAILED
startedAt
string<date-time>

A hora em que o envio começou a ser processado.

Última modificação em 10 de abril de 2026