Listar negocios en Zendesk Sell, con una API

Lista 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.

Identificador
zendesk_sell_list_deals

La llamada

POST https://connect.reportei.com/api/tools/zendesk_sell_list_deals/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ámetroTipoObligatorioDescripción
idsstringNoComma-separated ids of the deals to return, for example 1,2,3, from List deals or Create deal.
stage_idintegerNoId of a pipeline stage, from List stages.
contact_idintegerNoId of the primary contact of the deals, from List contacts.
organization_idintegerNoId of the organization of the deals, an organization contact from List contacts.
owner_idintegerNoId of the user who owns the deals, from List users.
hotbooleanNotrue returns only hot deals.
namestringNoName of the deal.
sort_bystringNoField to sort by: id, value, name, estimated_close_date, created_at or updated_at. Append :desc for descending order, for example value:desc.
pageintegerNoPage number, starting at 1.
per_pageintegerNoDeals 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_deals. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Zendesk Sell

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.