Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve una lista de todos los emails excluidos.
Parámetros
Nombre | Tipo | Descripción |
domainID | String | ID de dominio. Requerido. |
limit | Integer | Registros por página. Por defecto: 10. Máximo: 100. |
page | Integer | Número de página. Por defecto: 1. |
sort | String | Ordenar por: email, created_date. Por defecto: created_date. |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: asc. |
filters | String | Expresión para filtrar registros. Ejemplos: {"type": "manual"} filtra por exclusiones manuales; {"created_date":{"$gt":{"$ts":1711971302}}} filtra por fecha mayor a; {"email": "[email protected]"} filtra por email exacto. |
Respuesta
Campo | Descripción |
id | ID de exclusión |
Email excluido | |
created_date | Fecha de creación (UTC+00:00) |
type | Motivo: manual (agregado manualmente), hard (rebote duro), complaint (queja) |
Errores
Error | Descripción |
domain_required | El dominio es requerido |
domain_not_allowed | No existe el dominio informado |
invalid_direction | Tipo de ordenamiento incorrecto |
invalid_page | Número de página incorrecto — debe ser entero positivo |
invalid_limit | Cantidad de registros incorrecta — debe ser entero positivo |
malformed_filter | Expresión de filtro incorrecta |
Ejemplo de respuesta
{
"page": 1,
"limit": 100,
"total": 1,
"payload": [
{
"type": "complaint",
"email": "[email protected]",
"created_date": "2023-08-02T14:56:46+00:00",
"id": "64ca6oue28518c9631082e82"
}
]
}