Listar leads no Zendesk Sell, por uma API
Lista os leads que o usuário pode ver, filtrados pelos argumentos informados, 25 por página por padrão. Cada item traz o registro em data, e meta.count diz quantos vieram na página. Pagine com page e per_page.
- Identificador
- zendesk_sell_list_leads
A chamada
POST https://connect.reportei.com/api/tools/zendesk_sell_list_leads/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"ids": "<ids>"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| ids | string | Não | Comma-separated ids of the leads to return, for example 1,2,3, from List leads or Create lead. |
| owner_id | integer | Não | Id of the user who owns the leads, from List users. |
| status | string | Não | Name of a lead status, for example New or Unqualified. |
| string | Não | Email address of the lead. | |
| first_name | string | Não | First name of the lead. |
| last_name | string | Não | Last name of the lead. |
| organization_name | string | Não | Company name of the lead. |
| sort_by | string | Não | Field to sort by: id, first_name, last_name, organization_name, email, created_at or updated_at. Append :desc for descending order, for example created_at:desc. |
| page | integer | Não | Page number, starting at 1. |
| per_page | integer | Não | Leads 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_leads. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Zendesk Sell
- Criar leadPOSTCria um lead, uma pessoa ou empresa interessada no negócio, e o retorna em data. Envie last_name, organization_name ou ambos.
- Atualizar leadPUTAtualiza os campos enviados em data e retorna o lead. Os campos omitidos mantêm seus valores.
- Converter leadPOSTConverte um lead em contato, como pessoa, organização ou ambos conforme o lead, e por padrão também cria um negócio para ele. Retorna individual_id, organization_id e deal_id dos novos registros em data. As atividades do lead passam para eles em segundo plano.
- Listar contatosGETLista os contatos que o usuário pode ver, pessoas e organizações, filtrados pelos argumentos informados, 25 por página por padrão. Cada item traz o registro em data, e meta.count diz quantos vieram na página. Pagine com page e per_page.
- Criar contatoPOSTCria um contato, uma pessoa ou uma organização, e o retorna em data. Uma pessoa precisa de last_name e uma organização precisa de is_organization true e name.
- Atualizar contatoPUTAtualiza os campos enviados em data e retorna o contato. Os campos omitidos mantêm seus valores. Uma pessoa não pode virar organização, nem o contrário.
- Listar negóciosGETLista os negócios que o usuário pode ver, filtrados pelos argumentos informados, 25 por página por padrão. Cada item traz o registro em data, e meta.count diz quantos vieram na página. Pagine com page e per_page.
- Criar negócioPOSTCria um negócio para um contato e o retorna em data. name e contact_id são obrigatórios. Sem stage_id, o negócio começa na primeira etapa do funil padrão.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
