Referência da API

E-mail de entrada

Crie endereços e trabalhe com as conversas recebidas.

Filtrar e-mail de entrada

POST/domains/:id/inbound/setup

Chave de API

Provisionar o recebimento de entrada no SES

Requisição

curl https://sendhq.cc/api/v1/domains/id_value/inbound/setup \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "domain": "inbound.example.com",
  "status": "dns_pending",
  "record": {
    "type": "MX",
    "name": "inbound.example.com",
    "value": "10 inbound-smtp.us-east-1.amazonaws.com"
  }
}

POST/domains/:id/inbound/verify

Chave de API

Verificar o roteamento MX de entrada

Requisição

curl https://sendhq.cc/api/v1/domains/id_value/inbound/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "domain": "inbound.example.com",
  "status": "ready",
  "record": {
    "type": "MX"
  }
}

POST/inboxes

Chave de API

Criar um endereço de entrada

Requisição

curl https://sendhq.cc/api/v1/inboxes \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_id":"dom_…","local_part":"support","name":"Support"}'

Resposta 201

{
  "id": "inb_…",
  "address": "support@inbound.example.com",
  "status": "active"
}

GET/inboxes

Chave de API

Listar os endereços de entrada

Parâmetros de querydomain_id

Requisição

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

Resposta 200

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

GET/inboxes/:id

Chave de API

Obter um endereço de entrada

Requisição

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

Resposta 200

{
  "id": "inb_…",
  "address": "support@example.com",
  "status": "active"
}

PATCH/inboxes/:id

Chave de API

Renomear, ativar ou desativar uma caixa de entrada

Requisição

curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Customer support","status":"active"}'

Resposta 200

{
  "id": "inb_…",
  "status": "active"
}

PUT/inboxes/:id/forwarding

Chave de API

Encaminhar os e-mails recebidos de uma caixa de entrada para outro endereço

Defina `forward_to` como um endereço de e-mail, ou como null para desativar o encaminhamento. O endereço do próprio proprietário da conta é ativado imediatamente; qualquer outro endereço recebe um e-mail de confirmação (enviado do domínio verificado da caixa de entrada e contabilizado como um destinatário) e o encaminhamento fica pendente até que o link seja confirmado. As cópias encaminhadas são enviadas do endereço da caixa de entrada, com o remetente original em Reply-To, respeitam as supressões e os limites do plano e nunca são encaminhadas de novo.

Requisição

curl https://sendhq.cc/api/v1/inboxes/id_value/forwarding \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"forward_to":"team@example.net"}'

Resposta 200

{
  "id": "inb_…",
  "address": "support@example.com",
  "forwardTo": "team@example.net",
  "forwardStatus": "pending"
}

DELETE/inboxes/:id

Chave de API

Excluir uma caixa de entrada mantendo as mensagens

Requisição

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

Resposta 200

{
  "ok": true
}