v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB

5 - Gestão de E-mails

Enviar E-mail

Envia um e-mail avulso.

Autenticação: token de usuário (cliente → 403). O remetente vem do usuário autenticado.

Campos:

recipient (obrigatório)
content (obrigatório, salvo quando template_id é usado)
subject (opcional)
sender_name (opcional — default: endereço do remetente)
reply_to (opcional — default: endereço do remetente)
sign (opcional — booleano true ou string "true"; assina com o certificado do usuário)
attachment (opcional — conteúdo em base64) e attachment_name (opcional)
Múltiplos anexos: attachment_2/attachment_name_2, attachment_3/attachment_name_3, ...
template_id (opcional, int) + template_values (obrigatório quando há template_id; objeto com as variáveis do template)

Sucesso: 200 { "message": "Email sent successfully", "data": { "id", "message_id", "status": "sent" } }.

Erros: 400 JSON/dados inválidos, 403 cliente tentando enviar, 409 "Email deferred", 413 anexo acima de 10MB, 500.

post/api/v2/emails

Headers

Authorizationstring

Request body

object required

Example request

{
  "recipient": "destinatario@dominio.com",
  "subject": "Proposta Comercial",
  "content": "Prezado(a), segue em anexo a proposta comercial.",
  "sender_name": "Departamento de Implantação",
  "reply_to": "atendimento@bry.com.br",
  "sign": true,
  "attachment": "<conteudo-do-arquivo-em-base64>",
  "attachment_name": "documento.pdf"
}

Response

object required