Einen QrX CRM-Tarif, der die öffentliche API enthält. Die öffentliche API gehört zu Business und Enterprise. Ohne sie wird ein Aufruf mit einem Schlüssel, der die CRM-Scopes hat, mit 402 abgelehnt, und ein Schlüssel ohne die CRM-Scopes erhält zuerst 403 CRM_SCOPE_MISSING.

Einen API-Schlüssel (Schlüssel eines Vertriebskanals) mit angehakten CRM-Scopes, siehe „Einen API-Schlüssel mit Scopes erstellen“ unten.

Die Aufgaben-Endpunkte brauchen außerdem die Funktion Aufgaben, und die Endpunkte für Deals und Pipelines brauchen die Funktion Deals in Ihrem Tarif.

crm.read: alle GET-Aufrufe (Pipelines, Personen, Unternehmen, Deals, Aufgaben, Aktivitäten).

crm.write: alle POST- und PUT-Aufrufe (Personen, Unternehmen, Deals, Aufgaben und Notizen erstellen und ändern, einen Deal verschieben, eine Aufgabe abschließen). Ein Schreib-Scope schließt das Lesen nicht ein: Haken Sie beide an, wenn Sie beides brauchen.

Pipelines: GET /pipelines (Pipelines mit ihren Phasen: id, name, kind und probability).

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

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

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

Aufgaben: GET /tasks, GET /tasks/{id}, POST /tasks, PUT /tasks/{id}, POST /tasks/{id}/complete.

Aktivitäten: GET /activities?recordType=person&recordId={id}. recordType ist person, company oder deal.

Notizen: POST /notes.

Personen: zuletzt aktive zuerst. q durchsucht Namen, E-Mail-Adressen und Telefonnummern. Die Liste zeigt nur die primäre E-Mail und das primäre Telefon. GET /people/{id} liefert alle Kontaktpunkte, Tags und benutzerdefinierten Felder.

Unternehmen: zuletzt aktive zuerst. q durchsucht Namen und Domains.

Deals: zuletzt aktualisierte zuerst. Filter: pipelineId, stageId, status (open, won oder lost) und q.

Aufgaben: neueste zuerst. Filter: state (open oder done), assigneeUserId, personId, companyId und dealId.

Idempotency-Key: Jeder Erstellen-Aufruf (POST für Personen, Unternehmen, Deals, Aufgaben und Notizen) braucht den Header Idempotency-Key mit 8 bis 80 Zeichen: Buchstaben, Ziffern und . _ : -. Senden Sie denselben Schlüssel erneut, um es zu wiederholen, und Sie erhalten das erste Ergebnis statt eines zweiten Datensatzes. Verwenden Sie für jeden neuen Datensatz einen neuen Schlüssel. Ohne gültigen Schlüssel antwortet der Aufruf mit 400 IDEMPOTENCY_KEY_REQUIRED.

version: Jeder Datensatz trägt eine version. Ein PUT, das Verschieben eines Deals und der Abschluss einer Aufgabe müssen die Version senden, die Sie gelesen haben. Hat jemand den Datensatz inzwischen geändert, erhalten Sie 409 CRM_CONFLICT: Lesen Sie den Datensatz erneut und wiederholen Sie es mit der neuen Version.

Person: Felder sind unter anderem firstName, lastName, jobTitle, companyId, lifecycleStageId, ownerUserId, language, country, emails, phones, tagIds und customFields. Eine Person, deren E-Mail-Adresse oder Telefonnummer schon existiert, antwortet mit 409. Das Erstellen von Personen zählt auf das Personenlimit Ihres Tarifs.

Unternehmen: name, domains, vatNumber, chamberNumber, Adressfelder, industry, sizeBand, website, ownerUserId, lifecycleStageId, tagIds und customFields.

Deal: title, pipelineId, stageId, value, currency, expectedCloseOn, probability, ownerUserId, primaryPersonId, personIds, companyId, source, tagIds und customFields. Ohne Pipeline und Phase kommt der Deal in die Standard-Pipeline. Ein PUT kann die Phase nicht ändern: Nutzen Sie POST /deals/{id}/move mit toStageId, version und, bei einer Verlustphase, lostReasonId (und optional lostNote), wenn die Pipeline Verlustgründe hat.

Notiz: POST /notes mit recordType (person, company oder deal), recordId und text. Der Text ist reiner Text und wird als Absatz gespeichert.

400 IDEMPOTENCY_KEY_REQUIRED: Der Header Idempotency-Key fehlt oder hat die falsche Form.

401 UNAUTHORIZED: kein gültiges Zugriffstoken.

402: Ihr Tarif enthält die öffentliche API oder die Funktion nicht, oder CRM_PLAN_LIMIT_REACHED: Ein Tariflimit wie die Zahl der Personen ist erreicht. Wechseln Sie den Tarif im PortalX.

403 CRM_SCOPE_MISSING: Der Schlüssel hat crm.read oder crm.write nicht. Haken Sie den Scope an und warten Sie 30 Sekunden.

404 CRM_NOT_FOUND: Der Datensatz existiert in Ihrer Organisation nicht.

409 CRM_CONFLICT: Die Version ist veraltet (record_changed) oder die Person existiert schon (duplicate). Lesen Sie den Datensatz erneut.

422 VALIDATION_FAILED: Ein Feld ist ungültig, zum Beispiel eine fehlende Version, ein ungültiger Cursor oder eine Aufgabe ohne Bearbeiter. Das detail sagt, welches.

crm/person_created

crm/deal_created

crm/deal_moved

crm/deal_won

crm/deal_lost

crm/task_completed

crm/automation_triggered: gesendet von der Automatisierungsaktion Ein Webhook-Ereignis senden.

403 bei jedem CRM-Aufruf. Der Schlüssel hat Vollzugriff oder es fehlt der Scope. Schränken Sie den Schlüssel ein und haken Sie die CRM-Scopes an.

402 bei jedem CRM-Aufruf. Ihr Tarif enthält die öffentliche CRM-API nicht. Sie gehört zu Business und Enterprise.

409 beim Aktualisieren. Lesen Sie den Datensatz erneut und senden Sie seine aktuelle version.

Erstellen einer Aufgabe abgelehnt. Prüfen Sie, ob die assigneeUserId zu Ihrer Organisation gehört und der Benutzer das CRM nutzen darf.

Doppelte Datensätze nach einer Wiederholung. Verwenden Sie für die Wiederholung desselben Datensatzes denselben Idempotency-Key.