curl --request POST \
--url https://yghpblhxrfmxkwejvpjz.supabase.co/functions/v1/send-message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"communication_slug": "boas-vindas",
"recipient": {
"email": "usuario@exemplo.com",
"phone": "+5511999990000"
},
"variables": {
"nome": "Ricardo"
},
"language": "pt-BR",
"tag": [
"onboarding",
"junho-2024"
]
}
'{
"success": true,
"results": [
{
"channel": "email",
"status": "sent",
"provider_message_id": "010f018e...",
"log_id": "3f1c2b9e-..."
},
{
"channel": "whatsapp",
"status": "skipped",
"error": "Canal não configurado",
"reason_code": "channel_not_configured"
}
]
}Enviar mensagem
Envia uma comunicação cadastrada no painel para um destinatário (envio único) ou para até 100 destinatários (lote, campo messages). Sem channels, a mensagem sai em todos os canais ativos da comunicação, com a versão publicada de cada template (rascunhos do editor não saem pela API). Cada mensagem consome 1 do limite por minuto da conta (60 por padrão); o excedente é adiado e enviado nos minutos seguintes. Se a conta tiver um limite diário de mensagens, cada envio a um canal conta 1; acima dele, o canal volta failed com error_code: "daily_limit_reached". Por padrão o envio pela API é transacional e não é bloqueado pelo descadastro do contato; com respect_opt_out: true, o canal (e-mail, WhatsApp ou SMS) de que o contato se descadastrou é pulado e volta skipped com reason_code: "contato_descadastrado".
curl --request POST \
--url https://yghpblhxrfmxkwejvpjz.supabase.co/functions/v1/send-message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"communication_slug": "boas-vindas",
"recipient": {
"email": "usuario@exemplo.com",
"phone": "+5511999990000"
},
"variables": {
"nome": "Ricardo"
},
"language": "pt-BR",
"tag": [
"onboarding",
"junho-2024"
]
}
'{
"success": true,
"results": [
{
"channel": "email",
"status": "sent",
"provider_message_id": "010f018e...",
"log_id": "3f1c2b9e-..."
},
{
"channel": "whatsapp",
"status": "skipped",
"error": "Canal não configurado",
"reason_code": "channel_not_configured"
}
]
}Authorizations
Access token (at_...) obtido em /oauth-token, ou o par client_id:client_secret separado por dois-pontos, sem espaços.
Body
- Option 1
- Option 2
Slug de uma comunicação ativa da conta
Informe os campos dos canais que vão ser usados. Sem channels, um canal para o qual o destinatário não tem dado é pulado sem gerar registro; com channels, ele volta em results como skipped, com o campo que faltou em error. Exceção: o Slack sem canal padrão nem Incoming Webhook, para destinatário sem slack_channel, slack_user_id e email, é pulado sem registro nos dois casos.
Show child attributes
Show child attributes
Valores (texto) das {{variáveis}} do template
Show child attributes
Show child attributes
Idioma preferido. Ordem de escolha do template: este idioma, a base dele (pt), o idioma padrão da conta, o de fallback e en. Se nenhum casar e o canal tiver um único template ativo, ele é usado; senão, o canal volta skipped com No template found for any language
"pt-BR"
Restringe o envio a estes canais. Um canal pedido que não está ativo na comunicação é ignorado. Sem ele, a mensagem sai em todos os canais ativos da comunicação
email, whatsapp, sms, telegram, slack, web_push, in_app, push Uma ou mais tags para agrupar os envios e filtrar depois em /query-message-logs. Espaços nas pontas são removidos e tags vazias, descartadas
Com true, o canal (email, whatsapp ou sms) de que o contato se descadastrou é pulado e volta skipped com reason_code: "contato_descadastrado"; os outros canais seguem. O contato é reconhecido pelo recipient.email (sem diferenciar maiúsculas) e pelo recipient.phone. Os e-mails pela API não levam o link de descadastro, nem com true. Um valor que não seja true nem false é recusado com 400
Response
Requisição aceita. O HTTP 200 não garante entrega: confira results[].status de cada canal. Quando o limite por minuto é atingido, o envio único volta com deferred: true e status: "queued", sem results. Quando o limite diário da conta é atingido, o canal volta failed com error_code: "daily_limit_reached", também com HTTP 200.