API-referentie

Inkomende e-mail

Maak adressen aan en werk met ontvangen gesprekken.

Inkomende e-mail filteren

POST/domains/:id/inbound/setup

API-sleutel

Ontvangst van inkomende e-mail via SES inrichten

Request

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

200-respons

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

MX-routering voor inkomende e-mail verifiëren

Request

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

200-respons

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

POST/inboxes

API-sleutel

Een inkomend adres aanmaken

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-respons

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

GET/inboxes

API-sleutel

Inkomende adressen opvragen

Queryparametersdomain_id

Request

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

200-respons

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

GET/inboxes/:id

API-sleutel

Een inkomend adres ophalen

Request

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

200-respons

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

PATCH/inboxes/:id

API-sleutel

Een inbox hernoemen, inschakelen of uitschakelen

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-respons

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

PUT/inboxes/:id/forwarding

API-sleutel

Ontvangen e-mail van een inbox doorsturen naar een ander adres

Zet `forward_to` op een e-mailadres, of op null om doorsturen uit te schakelen. Het eigen adres van de accounteigenaar wordt direct geactiveerd; elk ander adres ontvangt een bevestigingsmail (verstuurd vanaf het geverifieerde domein van de inbox en geteld als één ontvanger) en het doorsturen blijft in afwachting tot de link is bevestigd. Doorgestuurde kopieën worden verstuurd vanaf het inboxadres met de oorspronkelijke afzender als Reply-To, respecteren suppressies en de limieten van het abonnement en worden nooit opnieuw doorgestuurd.

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-respons

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

DELETE/inboxes/:id

API-sleutel

Een inbox verwijderen en de berichten bewaren

Request

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

200-respons

{
  "ok": true
}