Referência da API

E-mails e threads

Envie, obtenha, pesquise e responda e-mails e inspecione eventos de entrega.

Filtrar e-mails e threads

POST/emails

Chave de API

Enviar um e-mail

Envie conteúdo transacional em HTML, texto ou template hospedado a partir de um domínio verificado do workspace. Envios diretos podem definir message_class como marketing quando isso estiver habilitado para o domínio remetente verificado. E-mails de marketing recebem cabeçalhos de descadastro gerenciados, a menos que uma integração própria configurada forneça sua própria URL HTTPS visível de descadastro com um clique.

Cabeçalhos opcionaisIdempotency-Key

Requisição

curl https://sendhq.cc/api/v1/emails \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'

Resposta 201

{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}

POST/emails/batch

Chave de API

Enviar até 100 mensagens individualizadas

Cabeçalhos opcionaisIdempotency-Key

Requisição

curl https://sendhq.cc/api/v1/emails/batch \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'

Resposta 201

{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}

GET/emails

Chave de API

Listar e-mails enviados e recebidos

Lista com os mais recentes primeiro, com filtros. `query` pesquisa assuntos, corpos, participantes e nomes de arquivos de anexos. `label`, `domain` e `category` aceitam um valor ou uma lista separada por vírgulas (corresponde a qualquer um); os marcadores podem ser IDs ou nomes. `archived=false` retorna a visão da caixa de entrada para e-mails recebidos. Os e-mails recebidos são classificados como `primary`, `updates` (newsletters, e-mails em massa e automáticos) ou `spam`, e marcados como `important`; o spam fica de fora, a menos que `category=spam` ou `include_spam=true`.

Parâmetros de querydirectionstatusdomaininbox_idlabelarchivedcategoryimportantinclude_spamfromtounreadafterbeforequerylimitoffset

Requisição

curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "data": [],
  "count": 0
}

GET/emails/:id

Chave de API

Obter um e-mail e seus anexos

Requisição

curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}

PATCH/emails/:id

Chave de API

Atualizar leitura, arquivamento, spam, categoria ou importância

Defina `read`, `archived`, `category` (`primary`, `updates` ou `spam`, apenas para e-mails recebidos) e `important`. Alterar `category` ou `important` ensina o SendHQ sobre o remetente: marcar como spam envia os próximos e-mails desse remetente para o spam, `Not spam` ignora as verificações automáticas de spam para ele, e a importância passa a valer para o remetente. Passe `learn: false` para alterar apenas esta mensagem.

Requisição

curl https://sendhq.cc/api/v1/emails/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"spam"}'

Resposta 200

{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}

DELETE/emails/:id

Chave de API

Excluir um e-mail retido

Requisição

curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "ok": true
}

GET/emails/:id/events

Chave de API

Listar os eventos de entrega de um e-mail

Requisição

curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "data": [],
  "count": 0
}

GET/threads/:id

Chave de API

Obter uma conversa em ordem cronológica

Requisição

curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "id": "em_…",
  "data": [],
  "count": 0
}