Listar listas de contactos en Mailjet, con una API
Lista las listas de contactos con ID, nombre, número de suscriptores y estado de eliminación. La respuesta trae Data, Count y Total; pagina con Limit y Offset.
- Identificador
- mailjet_list_contact_lists
La llamada
POST https://connect.reportei.com/api/tools/mailjet_list_contact_lists/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"Name": "<Name>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Name | string | No | Only the list with exactly this name. |
| IsDeleted | boolean | No | true returns only the deleted lists, false only the active ones. |
| Limit | integer | No | Lists per page, up to 1000. The default is 10. |
| Offset | integer | No | Index of the first list of the page. The default is 0. |
| Sort | string | No | Property and order separated by a space, for example Name ASC. Not every property can sort. |
Conexiones posibles
Tu cliente conecta su cuenta de Mailjet una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Usuario y contraseña
Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/mailjet_list_contact_lists. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Mailjet
- Listar contactosGETLista los contactos de la cuenta con email, nombre, estado de exclusión y fechas de actividad, opcionalmente solo los de una lista. La respuesta trae Data, Count y Total; pagina con Limit y Offset.
- Obtener contactoGETDevuelve un contacto, encontrado por su ID o por su dirección de email, con nombre, estado de exclusión y fechas de actividad. Úsalo para obtener el ID de un contacto que solo conoces por el email.
- Actualizar contactoPUTCambia el nombre de un contacto o su exclusión de emails de marketing. Solo cambian los campos enviados. Un contacto excluido sigue recibiendo emails transaccionales.
- Crear lista de contactosPOSTCrea una lista de contactos vacía y la devuelve con su ID.
- Gestionar contacto de la listaPOSTAñade un contacto a una lista por email, creando el contacto cuando el email es nuevo y fijando su nombre y propiedades, o lo da de baja o lo elimina de la lista, según Action.
- Listar propiedades de contactoGETLista las propiedades de contacto de la cuenta con nombre, tipo de dato y namespace. Los nombres son las claves de Properties en Manage list contact. La respuesta trae Data, Count y Total; pagina con Limit y Offset.
- Listar remitentesGETLista las direcciones y dominios remitentes de la cuenta con ID, email, nombre y estado. Solo un remitente Active puede enviar una campaña. La respuesta trae Data, Count y Total; pagina con Limit y Offset.
- Listar plantillasGETLista las plantillas de email con ID, nombre, propósitos y modo de edición. El ID vincula una plantilla a un borrador de campaña como su contenido. La respuesta trae Data, Count y Total; pagina con Limit y Offset.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
