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ámetroTipoObligatorioDescripción
sortstringNoField to sort by, on the first page only.Valores: createdAt, name
directionstringNoOrder of the sort, used only with sort.Valores: asc, desc
limitintegerNoSegments per page, up to 50.
afterstringNoThe 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

Ver las 14 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.