Listar segmentos no Omnisend, por uma API

Lista os segmentos com segmentID, name e status. O segmentID direciona campanhas e filtra contatos. A resposta tem segments e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.

Identificador
omnisend_list_segments

A chamada

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"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
sortstringNãoField to sort by, on the first page only.Valores: createdAt, name
directionstringNãoOrder of the sort, used only with sort.Valores: asc, desc
limitintegerNãoSegments per page, up to 50.
afterstringNãoThe paging.cursors.after of the previous page.

Conexões possíveis

O seu cliente conecta a conta do Omnisend uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/omnisend_list_segments. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Omnisend

Ver as 14 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.