CRM — Leads & Deals

Leads, Deals, Pipelines und Phasen — steuern Sie den Vertriebstrichter aus Ihren eigenen Systemen.

Deal

Endpoints

GET	/deals	Ruft die Sammlung der Deal-Ressourcen ab.
POST	/deals	Erstellt eine Deal-Ressource.
GET	/deals/{id}	Ruft eine Deal-Ressource ab.
PATCH	/deals/{id}	Aktualisiert die Deal-Ressource.
DELETE	/deals/{id}	Entfernt die Deal-Ressource.
POST	/deals/{id}/lose	Mark a deal lost.
POST	/deals/{id}/reopen	Reopen a won/lost deal.
POST	/deals/{id}/win	Mark a deal won.

Schemafelder

Feld	Typ	Beschreibung
id	string
title*	string
client*	object
contact	mixed
stage*	object
amountMinor	stringnull
currency	mixed
expectedCloseDate	string,null (date-time)
status	string
closedAt	string,null (date-time)
lostReason	mixed
lostReasonNote	stringnull
owner	mixed
lead	mixed
contract	string,null (iri-reference)
stageHistory	array
createdAt	string (date-time)
updatedAt	string (date-time)

Lead

Endpoints

GET	/leads	Ruft die Sammlung der Lead-Ressourcen ab.
POST	/leads	Erstellt eine Lead-Ressource.
GET	/leads/{id}	Ruft eine Lead-Ressource ab.
PATCH	/leads/{id}	Aktualisiert die Lead-Ressource.
DELETE	/leads/{id}	Entfernt die Lead-Ressource.
POST	/leads/{id}/convert	Convert a qualified lead into a Client + contacts + an open Deal.
POST	/leads/{id}/lose	Mark a lead lost.
POST	/leads/{id}/reopen	Reopen a lost lead.
GET	/leads/dedupe-check	Advisory duplicate check for a prospect — and the import wizard's three buckets.

Schemafelder

Feld	Typ	Beschreibung
id	string
companyName	stringnull

Pipeline

Endpoints

GET	/pipelines	Ruft die Sammlung der Pipeline-Ressourcen ab.
POST	/pipelines	Erstellt eine Pipeline-Ressource.
GET	/pipelines/{id}	Ruft eine Pipeline-Ressource ab.
PATCH	/pipelines/{id}	Aktualisiert die Pipeline-Ressource.
DELETE	/pipelines/{id}	Entfernt die Pipeline-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
isDefault	boolean
stages	array

Phase

Endpoints

GET	/stages	Ruft die Sammlung der Stage-Ressourcen ab.
POST	/stages	Erstellt eine Stage-Ressource.
GET	/stages/{id}	Ruft eine Stage-Ressource ab.
PATCH	/stages/{id}	Aktualisiert die Stage-Ressource.
DELETE	/stages/{id}	Entfernt die Stage-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
position	integer
probability	integer
isWon	boolean
isLost	boolean

Deal-Verlustgrund

Endpoints

GET	/deal-lost-reasons	Ruft die Sammlung der DealLostReason-Ressourcen ab.
POST	/deal-lost-reasons	Erstellt eine DealLostReason-Ressource.
GET	/deal-lost-reasons/{id}	Ruft eine DealLostReason-Ressource ab.
PATCH	/deal-lost-reasons/{id}	Aktualisiert die DealLostReason-Ressource.
DELETE	/deal-lost-reasons/{id}	Entfernt die DealLostReason-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
label*	string

Deal-Phasenverlauf

Endpoints

GET	/deal-stage-histories	Ruft die Sammlung der DealStageHistory-Ressourcen ab.
GET	/deal-stage-histories/{id}	Ruft eine DealStageHistory-Ressource ab.

Schemafelder

Feld	Typ	Beschreibung
id	string
fromStage	mixed
toStage	mixed
changedAt	string (date-time)
changedBy	mixed

Lead-Aktivität

Endpoints

GET	/lead-activities	Ruft die Sammlung der LeadActivity-Ressourcen ab.
POST	/lead-activities	Erstellt eine LeadActivity-Ressource.
GET	/lead-activities/{id}	Ruft eine LeadActivity-Ressource ab.
PATCH	/lead-activities/{id}	Aktualisiert die LeadActivity-Ressource.
DELETE	/lead-activities/{id}	Entfernt die LeadActivity-Ressource.

Schemafelder

Feld	Typ	Beschreibung
lead*	string (iri-reference)
contact	string,null (iri-reference)
type*	string
channel	stringnull
occurredAt*	string (date-time)
body	stringnull
externalId	stringnull
threadId	stringnull
fromMailbox	stringnull

Lead-Kontakt

Endpoints

GET	/lead-contacts	Ruft die Sammlung der LeadContact-Ressourcen ab.
POST	/lead-contacts	Erstellt eine LeadContact-Ressource.
GET	/lead-contacts/{id}	Ruft eine LeadContact-Ressource ab.
PATCH	/lead-contacts/{id}	Aktualisiert die LeadContact-Ressource.
DELETE	/lead-contacts/{id}	Entfernt die LeadContact-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
email	stringnull
phone	stringnull
linkedinUrl	stringnull
role	stringnull
isPrimary	boolean

Lead-Liste

Endpoints

GET	/lead-lists	Ruft die Sammlung der LeadList-Ressourcen ab.
POST	/lead-lists	Erstellt eine LeadList-Ressource.
GET	/lead-lists/{id}	Ruft eine LeadList-Ressource ab.
PATCH	/lead-lists/{id}	Aktualisiert die LeadList-Ressource.
DELETE	/lead-lists/{id}	Entfernt die LeadList-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
description	stringnull
owner	string,null (iri-reference)
channel	stringnull
status	string
segment	stringnull
memberships	array

Lead-Listenmitgliedschaft

Endpoints

GET	/lead-list-memberships	Ruft die Sammlung der LeadListMembership-Ressourcen ab.
POST	/lead-list-memberships	Erstellt eine LeadListMembership-Ressource.
GET	/lead-list-memberships/{id}	Ruft eine LeadListMembership-Ressource ab.
PATCH	/lead-list-memberships/{id}	Aktualisiert die LeadListMembership-Ressource.
DELETE	/lead-list-memberships/{id}	Entfernt die LeadListMembership-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
list*	object
lead*	string (iri-reference)
status	string
addedAt	string (date-time)
lastContactedAt	string,null (date-time)

Lead-Verlustgrund

Endpoints

GET	/lead-lost-reasons	Ruft die Sammlung der LeadLostReason-Ressourcen ab.
POST	/lead-lost-reasons	Erstellt eine LeadLostReason-Ressource.
GET	/lead-lost-reasons/{id}	Ruft eine LeadLostReason-Ressource ab.
PATCH	/lead-lost-reasons/{id}	Aktualisiert die LeadLostReason-Ressource.
DELETE	/lead-lost-reasons/{id}	Entfernt die LeadLostReason-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
label*	string

Lead-Phase

Endpoints

GET	/lead-stages	Ruft die Sammlung der LeadStage-Ressourcen ab.
POST	/lead-stages	Erstellt eine LeadStage-Ressource.
GET	/lead-stages/{id}	Ruft eine LeadStage-Ressource ab.
PATCH	/lead-stages/{id}	Aktualisiert die LeadStage-Ressource.
DELETE	/lead-stages/{id}	Entfernt die LeadStage-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
label*	string
position	integer	Sort key only — ties are legitimate and broken by label (see class docblock).

Lead-Phasenverlauf

Endpoints

GET	/lead-stage-histories	Ruft die Sammlung der LeadStageHistory-Ressourcen ab.
GET	/lead-stage-histories/{id}	Ruft eine LeadStageHistory-Ressource ab.

Schemafelder

Feld	Typ	Beschreibung
id	string
lead	string (iri-reference)
fromStage	string,null (iri-reference)
toStage	string,null (iri-reference)
changedAt	string (date-time)
changedBy	string,null (iri-reference)

CRM-Notiz

Endpoints

GET	/crm-notes	Ruft die Sammlung der CrmNote-Ressourcen ab.
POST	/crm-notes	Erstellt eine CrmNote-Ressource.
GET	/crm-notes/{id}	Ruft eine CrmNote-Ressource ab.
PATCH	/crm-notes/{id}	Aktualisiert die CrmNote-Ressource.
DELETE	/crm-notes/{id}	Entfernt die CrmNote-Ressource.

Schemafelder

Feld	Typ	Beschreibung
body*	string
lead	string,null (iri-reference)
deal	string,null (iri-reference)

PipeDrive-Lead

Endpoints

GET	/pipe-drive-leads	Ruft die Sammlung der PipeDriveLead-Ressourcen ab.
GET	/pipe-drive-leads/summary	Ruft die Sammlung der PipeDriveLead-Ressourcen ab.

Schemafelder

Feld	Typ	Beschreibung
id	string
type	string
title	string