Supprimer une tâche avec l'API Capsule CRM
Supprime définitivement une tâche. Pour clôturer une tâche qui a été faite, utilisez Mettre à jour une tâche avec status COMPLETED.
- Identifiant
- capsule_delete_task
L'appel
POST https://connect.reportei.com/api/tools/capsule_delete_task/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"taskId": 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 |
|---|---|---|---|
| taskId | integer | Oui | Id of the task, from List tasks or Create task. |
Connexions possibles
Votre client connecte son compte Capsule CRM une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/capsule, 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/capsule_delete_task. Il devient la définition de tool de votre agent sans conversion.
Autres tools Capsule CRM
- Lister les partiesGETListe les personnes et organisations du compte, 50 par page par défaut. Paginez avec page, à partir de 1, et perPage, jusqu'à 100 ; une page plus courte que perPage est la dernière.
- Rechercher des partiesGETRecherche des personnes et organisations avec les mêmes résultats que la recherche globale de Capsule, par nom, code postal ou numéro de téléphone, par exemple. Paginez avec page, à partir de 1, et perPage, jusqu'à 100.
- Obtenir une partyGETRenvoie une personne ou une organisation, avec ses adresses e-mail, numéros de téléphone, adresses postales et sites web et l'id de chacun.
- Créer une partyPOSTCrée une personne ou une organisation. Envoyez firstName et lastName pour une personne et name pour une organisation. organisation rattache une personne par id, ou par nom, ce qui crée l'organisation si elle n'existe pas encore. Sans owner, la party est attribuée à l'utilisateur connecté.
- Mettre à jour une partyPUTMet à jour une personne ou une organisation ; les champs omis ne changent pas. Dans les tableaux, un élément sans id est ajouté, un élément avec id est modifié et un élément avec id et _delete à true est supprimé. Les ids viennent d'Obtenir une party.
- Lister les opportunitésGETListe les opportunités du compte, avec party, milestone, value et expectedCloseOn, 50 par page par défaut. Paginez avec page, à partir de 1, et perPage, jusqu'à 100 ; une page plus courte que perPage est la dernière.
- Créer une opportunitéPOSTCrée une opportunité pour une party, à un milestone d'un pipeline. name, party et milestone sont obligatoires.
- Mettre à jour une opportunitéPUTMet à jour une opportunité ; les champs omis ne changent pas. La passer à un autre milestone, comme Won ou Lost, est un changement de milestone.
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.
