Listar etapas no Zendesk Sell, por uma API

Lista as etapas dos funis de vendas, com id, name, category (incoming, in_progress, won, lost ou unqualified), position, likelihood e pipeline_id, 25 por página por padrão.

Identificador
zendesk_sell_list_stages

A chamada

POST https://connect.reportei.com/api/tools/zendesk_sell_list_stages/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "pipeline_id": 1
  }
}

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
pipeline_idintegerNãoId of a pipeline, from the pipeline_id of List stages, to return only its stages.
activebooleanNãotrue returns only the stages of open deals, false only the won, lost and unqualified ones.
pageintegerNãoPage number, starting at 1.
per_pageintegerNãoStages per page, up to 100. The default is 25.

Conexões possíveis

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

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/zendesk_sell, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/zendesk_sell_list_stages. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Zendesk Sell

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.