Listar segmentos en Omnisend, con una API
Lista los segmentos con segmentID, name y status. El segmentID dirige campañas y filtra contactos. La respuesta tiene segments y paging; mientras paging.hasMore sea true, pasa paging.cursors.after como after.
- Identificador
- omnisend_list_segments
La llamada
POST https://connect.reportei.com/api/tools/omnisend_list_segments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"sort": "createdAt"
}
}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 |
|---|---|---|---|
| sort | string | No | Field to sort by, on the first page only.Valores: createdAt, name |
| direction | string | No | Order of the sort, used only with sort.Valores: asc, desc |
| limit | integer | No | Segments per page, up to 50. |
| after | string | No | The paging.cursors.after of the previous page. |
Conexiones posibles
Tu cliente conecta su cuenta de Omnisend 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/omnisend_list_segments. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Omnisend
- Listar contactosGETLista los contactos con id, email, phone, status, tags, segments y propiedades personalizadas, del más nuevo al más antiguo por defecto. La respuesta tiene contacts y paging; mientras paging.hasMore sea true, pasa paging.cursors.after como after y mantén los filtros.
- Crear contactoPOSTCrea un contacto, o actualiza el contacto que ya tiene el mismo identificador de email. Poner un canal en subscribed envía el mensaje de bienvenida de la marca, cuando esa automatización está activa, salvo que sendWelcomeMessage sea false.
- Actualizar contactoPATCHActualiza un contacto. Solo cambian los campos enviados, pero tags reemplaza la lista completa de tags: para solo agregar tags, usa Aplicar tags. Un estado de canal en identifiers suscribe o da de baja al contacto.
- Aplicar tagsPOSTAgrega tags a contactos, manteniendo los tags que ya tienen. Elige los contactos por contactIDs, emails, phones o segmentID; las selecciones se suman. Limitado a 60 llamadas por minuto.
- Listar plantillas de emailGETLista las plantillas de email con id y name, de la más nueva a la más antigua por defecto. El id es el cuerpo de una campaña de email. La respuesta tiene templates y paging; mientras paging.hasMore sea true, pasa paging.cursors.after como after.
- Listar campañasGETLista las campañas con id, name, status, channel, content, audience y configuración de envío, de la más nueva a la más antigua por defecto. La respuesta tiene campaigns y paging; mientras paging.hasMore sea true, pasa paging.cursors.after como after y mantén los filtros.
- Crear campañaPOSTCrea una campaña regular de email o SMS como borrador y la devuelve con su id. Una campaña de email necesita content.email.templateID, de Listar plantillas de email, y una de SMS necesita content.sms. No se envía nada hasta Enviar campaña.
- Actualizar campañaPATCHActualiza una campaña en estado draft. Solo cambian los campos enviados. La plantilla de email sigue siendo la definida al crear. Para cambiar una campaña que ya no es borrador, la app pide una copia.
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.
