Enviar e-mail

Envia um e-mail transacional, com HTML direto ou a partir de um template.

POSThttps://external-api.lip7.com.br/api/external/email/send

Escopoemail:sendAssíncrono — responde 202 com requestId

Por ser um envio, é assíncrono: responde 202 com requestId.

Suporta o header Idempotency-Key — veja Idempotência.

Body

tostringobrigatório

E-mail do destinatário.

fromstringobrigatório

E-mail remetente. Precisa ser um remetente verificado.

fromNamestringopcional

Nome de exibição do remetente.

replyTostringopcional

E-mail para respostas.

subjectstringopcional

Assunto. Obrigatório quando não usa templateId.

htmlstringopcional

Corpo HTML. Obrigatório quando não usa templateId.

textstringopcional

Versão em texto puro.

templateIdstringopcional

ID de um template de e-mail. Quando informado, dispensa subject e html.

variablesobjectopcional

Pares chave/valor para preencher o template.

attachmentsarrayopcional

Anexos do e-mail. Cada item aceita filename (obrigatório), mais um de content (conteúdo em base64, com ou sem prefixo data:) ou url (endereço público de onde baixar o arquivo). contentType é opcional — sem ele, o tipo é derivado da extensão do filename. Veja Anexos.

Regras de obrigatoriedade

Informe templateId ou html. Quando não usar templateId, o campo subject é obrigatório.

Erros comuns

Código	Causa
`400`	Payload inválido — campo obrigatório ausente, ou faltou `templateId`, `html` ou `subject`
`400`	Anexo inválido (`INVALID_EMAIL_ATTACHMENT`) — veja Anexos
`401`	API key inválida
`403`	Escopo insuficiente
`404`	Template não encontrado
`413`	Corpo da requisição acima de 25 MB

Requisição

curl -X POST "https://external-api.lip7.com.br/api/external/email/send" \
  -H "Content-Type: application/json" \
  -H "x-api-key: lip_SUA_CHAVE" \
  -d '{
    "to": "cliente@exemplo.com",
    "from": "no-reply@suaempresa.com",
    "fromName": "Sua Empresa",
    "subject": "Bem-vindo!",
    "html": "<h1>Olá!</h1><p>Obrigado por se cadastrar.</p>"
  }'

{
  "to": "cliente@exemplo.com",
  "from": "financeiro@suaempresa.com",
  "subject": "Sua nota fiscal",
  "html": "<p>Segue a nota fiscal em anexo.</p>",
  "attachments": [
    {
      "filename": "nota-fiscal.pdf",
      "content": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGgg...",
      "contentType": "application/pdf"
    },
    {
      "filename": "boleto.pdf",
      "url": "https://cdn.suaempresa.com/boletos/8f2a.pdf"
    }
  ]
}

Resposta

{
  "success": true,
  "data": { "requestId": "req_..." }
}