Obtener una restricción de envío

GET/v1/mail-restrictions/{id}

Para desarrolladores

Descripción

Devuelve una restricción de envío, vigente o levantada. Es la URL que entrega el header Location de POST /v1/mail-restrictions.

Guía relacionada

• Consultar las desuscripciones — Consulte las desuscripciones, que restringen la dirección que se da de baja.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope mail:read. Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Request

Path params:

idintegerobligatorio

Identificador de la restricción.

Response

200 OKEl mismo objeto que cada elemento de GET /v1/mail-restrictions.

idintegersiempre presente

Identificador de la restricción.

recipientstringsiempre presente

Email del destinatario restringido.

reasonstring | null

Motivo, ver vocabulario.

scopearray de string | null

Qué envíos bloquea la restricción: masivo, transaccional o ambos. null bloquea todo envío. Ver Alcance de una restricción.

restricted_atstring (date-time) | null

Fecha y hora en que se aplicó la restricción.

expires_atstring (date-time) | null

Fin previsto de un bloqueo temporal (reason: block). Al pasar esa fecha, la restricción se levanta automáticamente y pasa a exponer deleted_at. null en cualquier otro motivo, y en un bloqueo sin fecha de término.

deleted_atstring (date-time) | null

Fecha y hora en que se levantó la restricción. null si sigue vigente.

Errores

Código	Cuándo
403	La API key no tiene el scope mail:read, o la IP del cliente no está en la lista permitida.
404	No existe una restricción con ese id (restriction_not_found).

Request

curl -X GET "https://$API_HOST/v1/mail-restrictions/42" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"id": 42,
"recipient": "[email protected]",
"reason": "objection",
"scope": [
  "masivo"
],
"restricted_at": "2026-10-20T15:04:05Z",
"expires_at": null,
"deleted_at": null
}