Lister les étapes avec l'API Zendesk Sell
Liste les étapes des pipelines de vente, avec id, name, category (incoming, in_progress, won, lost ou unqualified), position, likelihood et pipeline_id, 25 par page par défaut.
- Identifiant
- zendesk_sell_list_stages
L'appel
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
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| pipeline_id | integer | Non | Id of a pipeline, from the pipeline_id of List stages, to return only its stages. |
| active | boolean | Non | true returns only the stages of open deals, false only the won, lost and unqualified ones. |
| page | integer | Non | Page number, starting at 1. |
| per_page | integer | Non | Stages per page, up to 100. The default is 25. |
Connexions possibles
Votre client connecte son compte Zendesk Sell une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/zendesk_sell, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/zendesk_sell_list_stages. Il devient la définition de tool de votre agent sans conversion.
Autres tools Zendesk Sell
- Lister les leadsGETListe les leads que l'utilisateur peut voir, filtrés selon les arguments donnés, 25 par page par défaut. Chaque élément contient l'enregistrement dans data, et meta.count indique combien sont arrivés dans la page. Paginez avec page et per_page.
- Créer un leadPOSTCrée un lead, une personne ou une entreprise intéressée par l'activité, et le renvoie dans data. Envoyez last_name, organization_name ou les deux.
- Mettre à jour un leadPUTMet à jour les champs envoyés dans data et renvoie le lead. Les champs omis gardent leurs valeurs.
- Convertir un leadPOSTConvertit un lead en contact, comme personne, organisation ou les deux selon le lead, et crée par défaut aussi un deal pour lui. Renvoie individual_id, organization_id et deal_id des nouveaux enregistrements dans data. Les activités du lead leur sont transférées en arrière-plan.
- Lister les contactsGETListe les contacts que l'utilisateur peut voir, personnes et organisations, filtrés selon les arguments donnés, 25 par page par défaut. Chaque élément contient l'enregistrement dans data, et meta.count indique combien sont arrivés dans la page. Paginez avec page et per_page.
- Créer un contactPOSTCrée un contact, une personne ou une organisation, et le renvoie dans data. Une personne a besoin de last_name et une organisation de is_organization true et name.
- Mettre à jour un contactPUTMet à jour les champs envoyés dans data et renvoie le contact. Les champs omis gardent leurs valeurs. Une personne ne peut pas devenir une organisation, ni l'inverse.
- Lister les dealsGETListe les deals que l'utilisateur peut voir, filtrés selon les arguments donnés, 25 par page par défaut. Chaque élément contient l'enregistrement dans data, et meta.count indique combien sont arrivés dans la page. Paginez avec page et per_page.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
