Nombre del servicio
GET https://api.envialosimple.email/api/v1/exclusions
Método de autenticación
Authorization: Bearer
Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la 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 | Cantidad de registros por página. Por defecto: 10. Máximo: 100. |
| page | Integer | Número de página. Por defecto: 1. |
| sort | String |
Ordenar por. Valores posibles: email ➔ Email. created_date ➔ Fecha de creación. Por defecto: Fecha de creación. |
| direction | String |
Tipo de ordenamiento. Valores posibles: asc ➔ Ascendente. desc ➔ Descendente. Por defecto: Ascendente. |
| filters | String |
Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). Ejemplos: {"type": "manual"} ➔ Filtra por exclusión agregada manualmente {"created_date":{"$gt":{"$ts":1711971302}}} ➔ Filtra por fecha mayor a {"email": "ejemplo@email.com.ar"} ➔ Filtra por email que sea = “ejemplo@email.com.ar” |
Respuesta
| Campo | Descripción |
| id | ID de exclusión. |
| Email excluido. | |
| created_date | Fecha. Zona horaria UTC+00:00. |
| type |
Motivo. Valores posibles: manual ➔ Agregado manualmente. hard ➔ Rebote duro. complaint ➔ Queja. |
Ejemplo de respuesta
{
"page": 1,
"limit": 100,
"payload": [
{
"type": "complaint",
"email": "ejemplo@email.com.ar",
"created_date": "2023-08-02T14:56:46+00:00",
"id": "64ca6oue28518c9631082e82"
}
],
"total": 1
}