Email API

Email API — Campanhas em Massa e Transacionais

Envie emails transacionais e campanhas em massa com templates personalizados, rastreamento de abertura, cliques e webhooks em tempo real. Suporte a variáveis, anexos e HTML customizado.

Introdução

A Email API da Yup Chat permite que você envie emails transacionais e campanhas em massa com alta entregabilidade. Com suporte a templates personalizados, variáveis dinâmicas, rastreamento de aberturas e cliques, e webhooks em tempo real, você pode criar experiências de comunicação por email profissionais e mensuráveis. A API também oferece segmentação avançada, relatórios detalhados e integração com suas ferramentas existentes.

Campanhas em Massa

Envie emails para milhares de destinatários com personalização automática e segmentação.

Templates Personalizados

Crie e gerencie templates com variáveis, condicionalidades e componentes reutilizáveis.

Rastreamento Avançado

Acompanhe aberturas, cliques, bounces e conversões em tempo real via webhooks.

Alta Entregabilidade

Infraestrutura otimizada com SPF, DKIM e DMARC para máxima entregabilidade.

Autenticação

HTTP Basic Authentication

A Email API utiliza autenticação HTTP Basic com seu ID e Token. Você deve enviar suas credenciais codificadas em Base64 no header Authorization.

Authorization: Basic <base64(ID:TOKEN)>

Exemplo: Se seu ID é "user123" e seu Token é "token456", você codifica "user123:token456" em Base64, resultando em "dXNlcjEyMzp0b2tlbjQ1Ng==".

Dica: Obtenha suas credenciais em "Informações da conta" no Dashboard da Yup Chat.

Exemplo de Autenticação

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/email/messages/email_123

Base URL

Todos os endpoints da Email API são acessados através da seguinte URL base:

https://api.yup.chat/v1/

Todos os exemplos de endpoints nesta documentação devem ser prefixados com esta URL base. Por exemplo, o endpoint POST /email/messages completo seria: https://api.yup.chat/v1/email/messages

Endpoints

POST/email/messages

Envia um email transacional ou campanha com suporte a templates e personalização.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`from`	String	Sim	Email do remetente (ex: [email protected])
`to`	String	Sim	Email do destinatário
`subject`	String	Sim	Assunto do email (máximo 255 caracteres)
`body`	String	Sim	Corpo do email em HTML ou texto plano
`template_id`	String	Não	ID de template pré-criado

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/email/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "from_name": "Sua Empresa",
    "to": "[email protected]",
    "subject": "Bem-vindo!",
    "body": "<h1>Olá!</h1><p>Obrigado por se cadastrar.</p>",
    "reply_email": "[email protected]"
  }'

Exemplo de Resposta (200 OK)

{
  "id": "email_1234567890abcdef",
  "status": "sent",
  "from": "[email protected]",
  "to": "[email protected]",
  "subject": "Bem-vindo!",
  "timestamp": "2024-01-19T10:30:00Z",
  "message_type": "outbound",
  "tracking_enabled": true,
  "failed_reason": null
}

GET/email/messages/:id

Consulta o status e detalhes de um email enviado.

Parâmetros

Parâmetro	Tipo	Descrição
`id`	String	ID único do email

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/email/messages/email_1234567890abcdef

Exemplo de Resposta (200 OK)

{
  "id": "email_1234567890abcdef",
  "status": "delivered",
  "from": "[email protected]",
  "to": "[email protected]",
  "subject": "Bem-vindo!",
  "timestamp": "2024-01-19T10:30:00Z",
  "delivered_at": "2024-01-19T10:30:05Z",
  "opened_at": "2024-01-19T10:35:00Z",
  "clicked_at": "2024-01-19T10:36:00Z",
  "tracking": {
    "opens": 3,
    "clicks": 1,
    "links_clicked": ["https://example.com/offer"]
  }
}

Status Retornados

Sent

O email foi aceito e enviado para o servidor de destino, mas ainda não foi entregue.

Delivered

O email foi entregue com sucesso ao servidor de email do destinatário.

Opened

O email foi aberto pelo destinatário (rastreamento de abertura detectado).

Clicked

O destinatário clicou em um link dentro do email.

Bounced

O email não pôde ser entregue (soft bounce). O servidor pode tentar novamente.

Failed

O email falhou permanentemente (hard bounce). Email inválido ou bloqueado.

Recursos Principais

Campanhas em Massa

Envie emails para milhares de destinatários com personalização automática

Templates Personalizados

Crie e gerencie templates com variáveis, condicionalidades e componentes reutilizáveis

Rastreamento Avançado

Acompanhe aberturas, cliques, bounces e conversões em tempo real

Segmentação

Segmente destinatários por comportamento, dados demográficos e histórico

Webhooks em Tempo Real

Receba notificações instantâneas sobre status de entrega e interações

Relatórios Detalhados

Acesse insights sobre taxa de abertura, cliques, bounces e ROI

Casos de Uso

Confirmação de Cadastro

Envie emails de confirmação com links de ativação de conta

Recuperação de Senha

Notificações seguras com links de reset de senha

Campanhas de Marketing

Envie newsletters e promoções para listas segmentadas

Notificações de Pedidos

Atualizações de status de pedidos e entregas

Relatórios Automáticos

Envie relatórios periódicos e dashboards por email

Pesquisas e Feedback

Colete feedback com links de pesquisa e rastreamento

Pronto para Começar?

Integre a Email API em minutos e comece a enviar campanhas e emails transacionais.