ℹ️ La référence technique de l’API est disponible dans la documentation API Pinpo. Consultez l’opération Stop qualifications dans la section Qualifications pour le verbe HTTP, l’URL, le format exact de la requête et les détails de la réponse.
Que fait l’opération ?
L’opération arrête le traitement des qualifications indiquées. L’agent n’envoie plus de message ni de relance pour ces qualifications. La qualification est clôturée comme une fin normale et reçoit le tag Traitement arrêté.
La requête accepte de 1 à 100 identifiants de qualification. Envoyez plusieurs requêtes si vous devez en arrêter davantage.
Comment implémenter l’appel ?
Récupérez une clé API pour l’organisation Pinpo concernée. La clé API est disponible depuis la plateforme dans Intégrations > Connexion via API KEY.
Identifiez les qualifications à arrêter. Utilisez les identifiants de qualification connus par votre système. Pour les conserver dès l’import, enregistrez l’identifiant de qualification renvoyé par l’API Pinpo lors de la création de la qualification.
Ouvrez l’opération Stop qualifications dans la section Qualifications de la documentation API. Reprenez exactement le verbe HTTP, l’URL et le schéma de requête affichés dans la référence, puis authentifiez l’appel avec la clé API de l’organisation.
Envoyez entre 1 et 100 identifiants par appel. Respectez le nom et le format des champs indiqués dans le schéma de l’opération.
Lisez le résultat de l’appel. Traitez séparément les qualifications arrêtées et les identifiants renvoyés comme introuvables afin de conserver une trace de ce qui a effectivement été arrêté.
Comment traiter les résultats ?
La réponse distingue les qualifications arrêtées des identifiants introuvables. Un identifiant inexistant ou appartenant à une autre organisation est renvoyé comme introuvable et ne fait pas échouer toute la requête. Les identifiants répétés ne sont traités qu’une seule fois.
Votre intégration doit donc vérifier la réponse et journaliser les éventuels identifiants introuvables, même lorsque l’appel a traité une partie de la liste. Les limites de fréquence habituelles de l’API s’appliquent.
Points d’attention
Protégez la clé API. Stockez-la côté serveur dans un gestionnaire de secrets ou une variable d’environnement. Ne l’intégrez jamais dans une application côté navigateur, une URL ou un dépôt de code public.
Limitez chaque appel à 100 identifiants. Découpez les listes plus longues en plusieurs requêtes.
L’arrêt ne redémarre pas une qualification. La reprise n’est pas disponible pour le moment.
Ce n’est pas un opt-out du contact. Une nouvelle qualification du même contact peut être traitée normalement.
Anticipez les effets d’une clôture normale. Les notifications de fin et les workflows configurés peuvent se déclencher. Vérifiez ces automatisations si votre intégration doit éviter tout nouveau contact.
Prévoyez une prise en charge humaine. Les messages reçus après l’arrêt sont enregistrés, mais l’agent n’y répond pas automatiquement.
🌟 Bonnes pratiques
Testez le flux avec un petit nombre de qualifications avant de l’utiliser en production.
Conservez les identifiants de qualification et le résultat de chaque appel pour faciliter le suivi et le diagnostic.
En cas de réponse partielle, ne réessayez pas aveuglément toute la liste : examinez les identifiants introuvables et relancez uniquement ceux qui doivent l’être, après vérification.
Consultez le schéma de l’opération dans la documentation API Pinpo avant chaque implémentation : il fait foi pour les champs, les formats et les codes de retour.