Skip to main content

​
O que os endpoints fazem

Enviam e-mail e SMS transacionais a partir do seu backend, fora dos Workflows. Cada envio bem-sucedido é cobrado como no marketplace: pacote de execuções ou saldo de tokens. São rotas HTTP dedicadas em /marketplace/messaging/, não substituem ações de fluxo como “Enviar notificação”.

​
URL base

POST https://api.gu1.ai/marketplace/messaging/send-email
POST https://api.gu1.ai/marketplace/messaging/send-sms

​
Autenticação

Igual ao restante da API gu1. Ver Autenticação. 
Authorization: Bearer SUA_API_KEY
Content-Type: application/json
Para utilizadores com várias organizações (sessão no painel): 
X-Organization-ID: <uuid>

​
Integrações no marketplace

CanalCódigo (referência)
E-mailglobal_sender_email
SMSglobal_sender_sms
Sem integração ativa ou sem MS_PROVIDER_URL configurado no servidor, a API retorna erro (400 ou de configuração).

​
Cobrança

Antes do envio, se o preço for > 0, verifica-se execução no pack ou saldo em tokens. Caso contrário, 400. As mensagens de erro destes endpoints estão em inglês no campo error.

​
E-mail: domínios e remitentes

  1. Adicionar e verificar domínio em Configurações → E-mail → Domínios.
  2. Criar remitente em Configurações → E-mail → Remitentes.
Na API: fromEmail (endereço completo) ou fromSenderId (UUID) — não os dois. Erros específicos se o domínio não existir, não estiver verificado ou o remitente não estiver cadastrado.

​
Conteúdo

  • Template: templateId + templateParams opcional (sem corpo inline).
  • Inline: htmlBody/textBody (e-mail) ou body (SMS); templateParams substitui {{variáveis}} também no subject (e-mail).
  • E-mail inline: subject obrigatório; pelo menos um de htmlBody ou textBody.
IDs de template: Configurações da organização → Applications → Templates de mensagens (copiar ID).

​
Resposta

{ "success": true, "messageId": "..." } ou { "success": false, "error": "..." }.

​
Próximos passos

Enviar e-mail

POST .../send-email

Enviar SMS

POST .../send-sms