API reference

Inbound email

Create addresses and work with received conversations.

Filter inbound email

POST/domains/:id/inbound/setup

API key

Provision SES inbound receiving

Request

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

200 Response

{
  "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

API key

Verify inbound MX routing

Request

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

200 Response

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

POST/inboxes

API key

Create an inbound address

Request

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"}'

201 Response

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

GET/inboxes

API key

List inbound addresses

Query parametersdomain_id

Request

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

200 Response

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

GET/inboxes/:id

API key

Retrieve an inbound address

Request

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

200 Response

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

PATCH/inboxes/:id

API key

Rename, enable, or disable an inbox

Request

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"}'

200 Response

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

PUT/inboxes/:id/forwarding

API key

Forward an inbox's received mail to another address

Set `forward_to` to an email address, or null to turn forwarding off. The account owner's own address activates immediately; any other address receives a confirmation email (sent from the inbox's verified domain and metered as one recipient) and forwarding stays pending until the link is confirmed. Forwarded copies are sent from the inbox address with the original sender as Reply-To, respect suppressions and plan limits, and are never re-forwarded.

Request

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"}'

200 Response

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

DELETE/inboxes/:id

API key

Delete an inbox while retaining messages

Request

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

200 Response

{
  "ok": true
}