Obtener una desuscripción

GET/v1/mail-unsubscribes/{mail_id}

Descripción

Retorna la desuscripción asociada a un mail específico.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope mail:read. Formato: Bearer FD.<key_id>.<token>.

X-Instance-Slugstringheaderobligatorio

Request

Path params:

mail_idstring

Identificador del mail.

Response

200 OKDevuelve un objeto con los campos que siguen.

mail_idstringobligatorio

Identificador del mail.

msg_idstring | null

Identificador del mensaje lógico.

tostring | null

Email del destinatario.

senderstring | null

Email del remitente.

unsubscribed_atstring (date-time) | null

Fecha y hora de la desuscripción.

typestring | null

Motivo declarado, ver vocabulario.

commentstring | null

Comentario dejado por el destinatario, si aplica.

sent_atstring (date-time) | null

Fecha y hora de entrega del mail original.

Vocabulario de type

Lo elige el destinatario en el formulario de baja, salvo one_click, que no pasa por formulario.

Valor	Significado
unspecified	Se dio de baja sin declarar motivo.
no_longer_interested	Ya no quiere recibir estos correos.
never_subscribed	Declara que nunca se suscribió a la lista.
inappropriate	Considera que el contenido es inapropiado.
spam_report	Declara que el correo es spam y debería reportarse.
other	Otro motivo; suele venir acompañado de comment.
one_click	Baja automática por un clic, sin formulario (RFC 8058). La dispara el cliente de correo del destinatario, no una persona.

Nota

Mismos campos que GET /v1/mail-unsubscribes.

Errores

Código	Cuándo
404	No existe una desuscripción asociada a ese mail_id (mail_unsubscribe_not_found).

Detalle en Errores genéricos.

Request

curl -X GET "https://$API_HOST/v1/mail-unsubscribes/0190abc..." \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"mail_id": "0190...",
"msg_id": "0190...",
"to": "alice@example.com",
"sender": "newsletter@example.com",
"unsubscribed_at": "2026-05-10T09:00:00Z",
"type": "no_longer_interested",
"comment": null,
"sent_at": "2026-05-08T14:22:33Z"
}