Listar leads en Zendesk Sell, con una API
Lista los leads que el usuario puede ver, filtrados por los argumentos indicados, 25 por página por defecto. Cada elemento trae el registro en data, y meta.count indica cuántos vinieron en la página. Pagina con page y per_page.
- Identificador
- zendesk_sell_list_leads
La llamada
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>"
}
}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 |
|---|---|---|---|
| ids | string | No | Comma-separated ids of the leads to return, for example 1,2,3, from List leads or Create lead. |
| owner_id | integer | No | Id of the user who owns the leads, from List users. |
| status | string | No | Name of a lead status, for example New or Unqualified. |
| string | No | Email address of the lead. | |
| first_name | string | No | First name of the lead. |
| last_name | string | No | Last name of the lead. |
| organization_name | string | No | Company name of the lead. |
| sort_by | string | No | 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 | No | Page number, starting at 1. |
| per_page | integer | No | Leads per page, up to 100. The default is 25. |
Conexiones posibles
Tu cliente conecta su cuenta de Zendesk Sell una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/zendesk_sell, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
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/zendesk_sell_list_leads. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Zendesk Sell
- Crear leadPOSTCrea un lead, una persona o empresa interesada en el negocio, y lo devuelve en data. Envía last_name, organization_name o ambos.
- Actualizar leadPUTActualiza los campos enviados en data y devuelve el lead. Los campos omitidos conservan sus valores.
- Convertir leadPOSTConvierte un lead en contacto, como persona, organización o ambos según el lead, y por defecto también crea un negocio para él. Devuelve individual_id, organization_id y deal_id de los nuevos registros en data. Las actividades del lead pasan a ellos en segundo plano.
- Listar contactosGETLista los contactos que el usuario puede ver, personas y organizaciones, filtrados por los argumentos indicados, 25 por página por defecto. Cada elemento trae el registro en data, y meta.count indica cuántos vinieron en la página. Pagina con page y per_page.
- Crear contactoPOSTCrea un contacto, una persona o una organización, y lo devuelve en data. Una persona necesita last_name y una organización necesita is_organization true y name.
- Actualizar contactoPUTActualiza los campos enviados en data y devuelve el contacto. Los campos omitidos conservan sus valores. Una persona no puede convertirse en organización, ni al revés.
- Listar negociosGETLista los negocios que el usuario puede ver, filtrados por los argumentos indicados, 25 por página por defecto. Cada elemento trae el registro en data, y meta.count indica cuántos vinieron en la página. Pagina con page y per_page.
- Crear negocioPOSTCrea un negocio para un contacto y lo devuelve en data. name y contact_id son obligatorios. Sin stage_id, el negocio empieza en la primera etapa del embudo por defecto.
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.
