Enviar e-mail
Referência API
Enviar e-mail
POST /marketplace/messaging/send-email — e-mail transacional com template ou HTML inline — pela API de mensageria da gu1 para comunicações com clientes.
POST
Enviar e-mail
Requer integração Email ativa no marketplace. Visão geral em Mensagens — visão geral.
Se omitir Remetente personalizado (
Se enviar
Modo template:
Endpoint
Cabeçalhos
Corpo
string
required
E-mail do destinatário.
string
Endereço completo (ex.:
noreply@meu-dominio.com). O domínio deve estar registrado e verificado na organização (Configurações → E-mail → Domínios). Não é obrigatório cadastrar esse endereço em Remetentes se o domínio já estiver verificado. Exclusivo com fromSenderId.string (UUID)
UUID do remetente. Exclusivo com
fromEmail.fromEmail e fromSenderId, a API usa o remetente padrão da plataforma Gu1. Comportamento esperado, não é erro.
Remetente personalizado (fromEmail)
Se enviar fromEmail, por exemplo example@meu-dominio.com, a API valida o domínio (meu-dominio.com) antes do envio. A resposta é 400 com { "success": false, "error": "<mensagem em inglês>" }; o e-mail não é enviado até o domínio estar verificado.
Exemplo de rejeição (domínio não verificado):
object
Mapa para
{{placeholders}}. Padrão {}.templateId (canal email). Sem htmlBody/textBody. subject opcional como fallback.
Modo inline: subject obrigatório; htmlBody e/ou textBody. Sem templateId.
Exemplo (inline + variáveis)
Erros e HTTP
Na maioria dos casos:{ "success": false, "error": "<mensagem em inglês>" }. Corpos inválidos podem retornar outro formato (ex.: Zod) com 400. Mensagens de negócio em error são em inglês.
Sempre verifique
success e error; o provedor pode responder falha com 200 e success: false.