Referencia de la API

Correo entrante

Cree direcciones y trabaje con las conversaciones recibidas.

Filtrar correo entrante

POST/domains/:id/inbound/setup

Clave de API

Aprovisionar la recepción de correo entrante de SES

Solicitud

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

Respuesta 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

Clave de API

Verificar el enrutamiento MX de entrada

Solicitud

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

Respuesta 200

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

POST/inboxes

Clave de API

Crear una dirección de entrada

Solicitud

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

Respuesta 201

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

GET/inboxes

Clave de API

Listar las direcciones de entrada

Parámetros de consultadomain_id

Solicitud

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

Respuesta 200

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

GET/inboxes/:id

Clave de API

Obtener una dirección de entrada

Solicitud

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

Respuesta 200

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

PATCH/inboxes/:id

Clave de API

Renombrar, habilitar o deshabilitar una bandeja de entrada

Solicitud

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

Respuesta 200

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

PUT/inboxes/:id/forwarding

Clave de API

Reenviar el correo recibido en una bandeja de entrada a otra dirección

Establezca `forward_to` en una dirección de correo, o en null para desactivar el reenvío. La propia dirección del titular de la cuenta se activa de inmediato; cualquier otra dirección recibe un correo de confirmación (enviado desde el dominio verificado de la bandeja de entrada y contabilizado como un destinatario) y el reenvío queda pendiente hasta que se confirme el enlace. Las copias reenviadas se envían desde la dirección de la bandeja de entrada con el remitente original como Reply-To, respetan las supresiones y los límites del plan, y nunca se vuelven a reenviar.

Solicitud

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

Respuesta 200

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

DELETE/inboxes/:id

Clave de API

Eliminar una bandeja de entrada conservando los mensajes

Solicitud

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

Respuesta 200

{
  "ok": true
}