Une offre CRM de QrX qui inclut l'API publique. L'API publique fait partie de Business et Enterprise. Sans elle, un appel dont la clé a les scopes CRM est refusé avec 402, et une clé sans les scopes CRM reçoit d'abord 403 CRM_SCOPE_MISSING.

Une clé API (clé de canal de vente) avec les scopes CRM cochés, voir « Créer une clé API restreinte » ci-dessous.

Les endpoints des tâches demandent aussi la fonction Tâches, et les endpoints des affaires et des pipelines demandent la fonction Affaires dans votre offre.

crm.read : tous les appels GET (pipelines, personnes, entreprises, affaires, tâches, activités).

crm.write : tous les appels POST et PUT (créer et modifier des personnes, entreprises, affaires, tâches et notes, déplacer une affaire, terminer une tâche). Un scope d'écriture n'inclut pas la lecture : cochez les deux si vous avez besoin des deux.

Pipelines : GET /pipelines (pipelines avec leurs étapes : id, nom, type et probabilité).

Personnes : GET /people, GET /people/{id}, POST /people, PUT /people/{id}.

Entreprises : GET /companies, GET /companies/{id}, POST /companies, PUT /companies/{id}.

Affaires : GET /deals, GET /deals/{id}, POST /deals, PUT /deals/{id}, POST /deals/{id}/move.

Tâches : GET /tasks, GET /tasks/{id}, POST /tasks, PUT /tasks/{id}, POST /tasks/{id}/complete.

Activités : GET /activities?recordType=person&recordId={id}. recordType vaut person, company ou deal.

Notes : POST /notes.

Personnes : les plus récemment actives d'abord. q cherche dans les noms, adresses e-mail et numéros de téléphone. La liste n'affiche que l'e-mail et le téléphone principaux ; GET /people/{id} renvoie tous les moyens de contact, les tags et les champs personnalisés.

Entreprises : les plus récemment actives d'abord. q cherche dans les noms et les domaines.

Affaires : les plus récemment mises à jour d'abord. Filtres : pipelineId, stageId, status (open, won ou lost) et q.

Tâches : les plus récentes d'abord. Filtres : state (open ou done), assigneeUserId, personId, companyId et dealId.

Idempotency-Key : chaque appel de création (POST pour les personnes, entreprises, affaires, tâches et notes) demande l'en-tête Idempotency-Key de 8 à 80 caractères : lettres, chiffres et . _ : -. Renvoyez la même clé pour réessayer et vous obtenez le premier résultat au lieu d'une deuxième fiche. Utilisez une nouvelle clé pour chaque nouvelle fiche. Sans clé valide, l'appel répond 400 IDEMPOTENCY_KEY_REQUIRED.

version : chaque fiche porte une version. Un PUT, un déplacement d'affaire et la fin d'une tâche doivent envoyer la version que vous avez lue. Si quelqu'un a modifié la fiche entre-temps, vous obtenez 409 CRM_CONFLICT : relisez la fiche et réessayez avec la nouvelle version.

Personne : les champs comprennent firstName, lastName, jobTitle, companyId, lifecycleStageId, ownerUserId, language, country, emails, phones, tagIds et customFields. Une personne dont l'adresse e-mail ou le numéro de téléphone existe déjà répond 409. Créer des personnes compte dans la limite de personnes de votre offre.

Entreprise : name, domains, vatNumber, chamberNumber, champs d'adresse, industry, sizeBand, website, ownerUserId, lifecycleStageId, tagIds et customFields.

Affaire : title, pipelineId, stageId, value, currency, expectedCloseOn, probability, ownerUserId, primaryPersonId, personIds, companyId, source, tagIds et customFields. Sans pipeline ni étape, l'affaire va dans le pipeline par défaut. Un PUT ne peut pas changer l'étape : utilisez POST /deals/{id}/move avec toStageId, version et, pour une étape de perte, lostReasonId (et éventuellement lostNote) quand le pipeline a des motifs de perte.

Note : POST /notes avec recordType (person, company ou deal), recordId et text. Le texte est du texte brut et il est stocké comme un paragraphe.

400 IDEMPOTENCY_KEY_REQUIRED : l'en-tête Idempotency-Key est absent ou a un mauvais format.

401 UNAUTHORIZED : pas de jeton d'accès valide.

402 : votre offre n'inclut pas l'API publique ou la fonction, ou CRM_PLAN_LIMIT_REACHED : une limite de l'offre, comme le nombre de personnes, est atteinte. Passez à une offre supérieure dans PortalX.

403 CRM_SCOPE_MISSING : la clé n'a pas crm.read ou crm.write. Cochez le scope et attendez 30 secondes.

404 CRM_NOT_FOUND : la fiche n'existe pas dans votre organisation.

409 CRM_CONFLICT : la version est périmée (record_changed) ou la personne existe déjà (duplicate). Relisez la fiche.

422 VALIDATION_FAILED : un champ n'est pas valide, par exemple une version manquante, un curseur invalide ou une tâche sans attributaire. Le detail indique lequel.

crm/person_created

crm/deal_created

crm/deal_moved

crm/deal_won

crm/deal_lost

crm/task_completed

crm/automation_triggered : envoyé par l'action d'automatisation Envoyer un événement webhook.

403 sur chaque appel CRM. La clé a l'accès complet ou n'a pas le scope. Restreignez la clé et cochez les scopes CRM.

402 sur chaque appel CRM. Votre offre n'inclut pas l'API publique du CRM. Elle fait partie de Business et Enterprise.

409 à la mise à jour. Relisez la fiche et envoyez sa version actuelle.

Création de tâche refusée. Vérifiez que assigneeUserId appartient à votre organisation et que l'utilisateur peut utiliser le CRM.

Fiches en double après une nouvelle tentative. Réutilisez la même Idempotency-Key pour une nouvelle tentative de la même fiche.