Listar campañas de email en Brevo, con una API
Lista las campañas de email, de la más reciente a la más antigua por defecto. La respuesta trae campaigns y count; pagina con limit y offset. Las estadísticas solo vienen cuando se envía statistics.
- Identificador
- brevo_list_email_campaigns
La llamada
POST https://connect.reportei.com/api/tools/brevo_list_email_campaigns/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"type": "classic"
}
}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 |
|---|---|---|---|
| type | string | No | Only campaigns of this type.Valores: classic, trigger |
| status | string | No | Only campaigns in this status.Valores: suspended, archive, sent, queued, draft, inProcess, inReview, cancelling, cancelled |
| statistics | string | No | Statistics to include. They cover only the last 6 months; for older campaigns use Get email campaign.Valores: globalStats, linksStats, statsByDomain |
| startDate | string | No | Only campaigns sent from this date-time. Requires endDate, works only without status or with status sent, and the range is up to 2 years. |
| endDate | string | No | Only campaigns sent up to this date-time. Requires startDate. |
| excludeHtmlContent | boolean | No | true leaves the HTML of each campaign out of the response. |
| sort | string | No | Order of creation. The default is desc.Valores: asc, desc |
| limit | integer | No | Campaigns per page, up to 100. The default is 50. |
| offset | integer | No | Index of the first campaign of the page. The default is 0. |
Conexiones posibles
Tu cliente conecta su cuenta de Brevo una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave 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/brevo_list_email_campaigns. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Brevo
- Listar contactosGETLista los contactos, del más reciente al más antiguo por defecto, con filtro opcional por lista, fecha o atributo. La respuesta trae contacts y count; pagina con limit y offset.
- Obtener contactoGETDevuelve un contacto con sus atributos, listas y las estadísticas de campañas de los últimos 90 días.
- Crear contactoPOSTCrea un contacto. Envía email, o el atributo SMS, o ext_id. Con updateEnabled en true, un contacto existente con el mismo identificador se actualiza en lugar de fallar.
- Actualizar contactoPUTActualiza un contacto. Solo cambian los campos enviados: listIds agrega el contacto a listas y unlinkListIds lo quita de listas.
- Listar listas de contactosGETLista las listas de contactos con id, name, folderId y suscriptores únicos. La respuesta trae lists y count; pagina con limit y offset.
- Crear lista de contactosPOSTCrea una lista de contactos vacía en una carpeta y devuelve su id.
- Obtener campaña de emailGETDevuelve una campaña de email con su configuración, destinatarios y estadísticas del informe.
- Crear campaña de emailPOSTCrea una campaña de email como borrador y devuelve su id. Envía el contenido en exactamente uno de htmlContent, htmlUrl o templateId. Definir scheduledAt programa el envío, y entonces recipients es obligatorio.
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.
