CRM — prospects et affaires

Prospects, affaires, pipelines et étapes — pilotez votre tunnel de vente depuis vos propres systèmes.

Affaire

Points de terminaison

GET	/deals	Récupère la collection de ressources Deal.
POST	/deals	Crée une ressource Deal.
GET	/deals/{id}	Récupère une ressource Deal.
PATCH	/deals/{id}	Met à jour la ressource Deal.
DELETE	/deals/{id}	Supprime la ressource Deal.
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.

Champs de schéma

Champ	Type	Description
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)

Prospect

Points de terminaison

GET	/leads	Récupère la collection de ressources Lead.
POST	/leads	Crée une ressource Lead.
GET	/leads/{id}	Récupère une ressource Lead.
PATCH	/leads/{id}	Met à jour la ressource Lead.
DELETE	/leads/{id}	Supprime la ressource Lead.
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.

Champs de schéma

Champ	Type	Description
id	string
companyName	stringnull

Pipeline

Points de terminaison

GET	/pipelines	Récupère la collection de ressources Pipeline.
POST	/pipelines	Crée une ressource Pipeline.
GET	/pipelines/{id}	Récupère une ressource Pipeline.
PATCH	/pipelines/{id}	Met à jour la ressource Pipeline.
DELETE	/pipelines/{id}	Supprime la ressource Pipeline.

Champs de schéma

Champ	Type	Description
id	string
name*	string
isDefault	boolean
stages	array

Étape

Points de terminaison

GET	/stages	Récupère la collection de ressources Stage.
POST	/stages	Crée une ressource Stage.
GET	/stages/{id}	Récupère une ressource Stage.
PATCH	/stages/{id}	Met à jour la ressource Stage.
DELETE	/stages/{id}	Supprime la ressource Stage.

Champs de schéma

Champ	Type	Description
id	string
name*	string
position	integer
probability	integer
isWon	boolean
isLost	boolean

Motif de perte d'affaire

Points de terminaison

GET	/deal-lost-reasons	Récupère la collection de ressources DealLostReason.
POST	/deal-lost-reasons	Crée une ressource DealLostReason.
GET	/deal-lost-reasons/{id}	Récupère une ressource DealLostReason.
PATCH	/deal-lost-reasons/{id}	Met à jour la ressource DealLostReason.
DELETE	/deal-lost-reasons/{id}	Supprime la ressource DealLostReason.

Champs de schéma

Champ	Type	Description
id	string
label*	string

Historique des étapes de l'affaire

Points de terminaison

GET	/deal-stage-histories	Récupère la collection de ressources DealStageHistory.
GET	/deal-stage-histories/{id}	Récupère une ressource DealStageHistory.

Champs de schéma

Champ	Type	Description
id	string
fromStage	mixed
toStage	mixed
changedAt	string (date-time)
changedBy	mixed

Activité de prospect

Points de terminaison

GET	/lead-activities	Récupère la collection de ressources LeadActivity.
POST	/lead-activities	Crée une ressource LeadActivity.
GET	/lead-activities/{id}	Récupère une ressource LeadActivity.
PATCH	/lead-activities/{id}	Met à jour la ressource LeadActivity.
DELETE	/lead-activities/{id}	Supprime la ressource LeadActivity.

Champs de schéma

Champ	Type	Description
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

Contact de prospect

Points de terminaison

GET	/lead-contacts	Récupère la collection de ressources LeadContact.
POST	/lead-contacts	Crée une ressource LeadContact.
GET	/lead-contacts/{id}	Récupère une ressource LeadContact.
PATCH	/lead-contacts/{id}	Met à jour la ressource LeadContact.
DELETE	/lead-contacts/{id}	Supprime la ressource LeadContact.

Champs de schéma

Champ	Type	Description
id	string
name*	string
email	stringnull
phone	stringnull
linkedinUrl	stringnull
role	stringnull
isPrimary	boolean

Liste de prospects

Points de terminaison

GET	/lead-lists	Récupère la collection de ressources LeadList.
POST	/lead-lists	Crée une ressource LeadList.
GET	/lead-lists/{id}	Récupère une ressource LeadList.
PATCH	/lead-lists/{id}	Met à jour la ressource LeadList.
DELETE	/lead-lists/{id}	Supprime la ressource LeadList.

Champs de schéma

Champ	Type	Description
id	string
name*	string
description	stringnull
owner	string,null (iri-reference)
channel	stringnull
status	string
segment	stringnull
memberships	array

Appartenance à une liste de prospects

Points de terminaison

GET	/lead-list-memberships	Récupère la collection de ressources LeadListMembership.
POST	/lead-list-memberships	Crée une ressource LeadListMembership.
GET	/lead-list-memberships/{id}	Récupère une ressource LeadListMembership.
PATCH	/lead-list-memberships/{id}	Met à jour la ressource LeadListMembership.
DELETE	/lead-list-memberships/{id}	Supprime la ressource LeadListMembership.

Champs de schéma

Champ	Type	Description
id	string
list*	object
lead*	string (iri-reference)
status	string
addedAt	string (date-time)
lastContactedAt	string,null (date-time)

Motif de perte de prospect

Points de terminaison

GET	/lead-lost-reasons	Récupère la collection de ressources LeadLostReason.
POST	/lead-lost-reasons	Crée une ressource LeadLostReason.
GET	/lead-lost-reasons/{id}	Récupère une ressource LeadLostReason.
PATCH	/lead-lost-reasons/{id}	Met à jour la ressource LeadLostReason.
DELETE	/lead-lost-reasons/{id}	Supprime la ressource LeadLostReason.

Champs de schéma

Champ	Type	Description
id	string
label*	string

Étape de prospect

Points de terminaison

GET	/lead-stages	Récupère la collection de ressources LeadStage.
POST	/lead-stages	Crée une ressource LeadStage.
GET	/lead-stages/{id}	Récupère une ressource LeadStage.
PATCH	/lead-stages/{id}	Met à jour la ressource LeadStage.
DELETE	/lead-stages/{id}	Supprime la ressource LeadStage.

Champs de schéma

Champ	Type	Description
id	string
label*	string
position	integer	Sort key only — ties are legitimate and broken by label (see class docblock).

Historique des étapes de prospect

Points de terminaison

GET	/lead-stage-histories	Récupère la collection de ressources LeadStageHistory.
GET	/lead-stage-histories/{id}	Récupère une ressource LeadStageHistory.

Champs de schéma

Champ	Type	Description
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)

Note CRM

Points de terminaison

GET	/crm-notes	Récupère la collection de ressources CrmNote.
POST	/crm-notes	Crée une ressource CrmNote.
GET	/crm-notes/{id}	Récupère une ressource CrmNote.
PATCH	/crm-notes/{id}	Met à jour la ressource CrmNote.
DELETE	/crm-notes/{id}	Supprime la ressource CrmNote.

Champs de schéma

Champ	Type	Description
body*	string
lead	string,null (iri-reference)
deal	string,null (iri-reference)

Prospect PipeDrive

Points de terminaison

GET	/pipe-drive-leads	Récupère la collection de ressources PipeDriveLead.
GET	/pipe-drive-leads/summary	Récupère la collection de ressources PipeDriveLead.

Champs de schéma

Champ	Type	Description
id	string
type	string
title	string