CRM — leads & deals

Leads, deals, pipelines and stages — drive the sales funnel from your own systems.

Deal

Endpoints

GET	/deals	Retrieves the collection of Deal resources.
POST	/deals	Creates a Deal resource.
GET	/deals/{id}	Retrieves a Deal resource.
PATCH	/deals/{id}	Updates the Deal resource.
DELETE	/deals/{id}	Removes the Deal resource.
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.

Schema fields

Field	Type	Description
id	string
title*	string
client	mixed
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	Retrieves the collection of Lead resources.
POST	/leads	Creates a Lead resource.
GET	/leads/{id}	Retrieves a Lead resource.
PATCH	/leads/{id}	Updates the Lead resource.
DELETE	/leads/{id}	Removes the Lead resource.
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.

Schema fields

Field	Type	Description
id	string
companyName	stringnull

Pipeline

Endpoints

GET	/pipelines	Retrieves the collection of Pipeline resources.
POST	/pipelines	Creates a Pipeline resource.
GET	/pipelines/{id}	Retrieves a Pipeline resource.
PATCH	/pipelines/{id}	Updates the Pipeline resource.
DELETE	/pipelines/{id}	Removes the Pipeline resource.

Schema fields

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

Stage

Endpoints

GET	/stages	Retrieves the collection of Stage resources.
POST	/stages	Creates a Stage resource.
GET	/stages/{id}	Retrieves a Stage resource.
PATCH	/stages/{id}	Updates the Stage resource.
DELETE	/stages/{id}	Removes the Stage resource.

Schema fields

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

Deal Lost Reason

Endpoints

GET	/deal-lost-reasons	Retrieves the collection of DealLostReason resources.
POST	/deal-lost-reasons	Creates a DealLostReason resource.
GET	/deal-lost-reasons/{id}	Retrieves a DealLostReason resource.
PATCH	/deal-lost-reasons/{id}	Updates the DealLostReason resource.
DELETE	/deal-lost-reasons/{id}	Removes the DealLostReason resource.

Schema fields

Field	Type	Description
id	string
label*	string

Deal Stage History

Endpoints

GET	/deal-stage-histories	Retrieves the collection of DealStageHistory resources.
GET	/deal-stage-histories/{id}	Retrieves a DealStageHistory resource.

Schema fields

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

Lead Activity

Endpoints

GET	/lead-activities	Retrieves the collection of LeadActivity resources.
POST	/lead-activities	Creates a LeadActivity resource.
GET	/lead-activities/{id}	Retrieves a LeadActivity resource.
PATCH	/lead-activities/{id}	Updates the LeadActivity resource.
DELETE	/lead-activities/{id}	Removes the LeadActivity resource.

Schema fields

Field	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

Lead Contact

Endpoints

GET	/lead-contacts	Retrieves the collection of LeadContact resources.
POST	/lead-contacts	Creates a LeadContact resource.
GET	/lead-contacts/{id}	Retrieves a LeadContact resource.
PATCH	/lead-contacts/{id}	Updates the LeadContact resource.
DELETE	/lead-contacts/{id}	Removes the LeadContact resource.

Schema fields

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

Lead List

Endpoints

GET	/lead-lists	Retrieves the collection of LeadList resources.
POST	/lead-lists	Creates a LeadList resource.
GET	/lead-lists/{id}	Retrieves a LeadList resource.
PATCH	/lead-lists/{id}	Updates the LeadList resource.
DELETE	/lead-lists/{id}	Removes the LeadList resource.

Schema fields

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

Lead List Membership

Endpoints

GET	/lead-list-memberships	Retrieves the collection of LeadListMembership resources.
POST	/lead-list-memberships	Creates a LeadListMembership resource.
GET	/lead-list-memberships/{id}	Retrieves a LeadListMembership resource.
PATCH	/lead-list-memberships/{id}	Updates the LeadListMembership resource.
DELETE	/lead-list-memberships/{id}	Removes the LeadListMembership resource.

Schema fields

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

Lead Lost Reason

Endpoints

GET	/lead-lost-reasons	Retrieves the collection of LeadLostReason resources.
POST	/lead-lost-reasons	Creates a LeadLostReason resource.
GET	/lead-lost-reasons/{id}	Retrieves a LeadLostReason resource.
PATCH	/lead-lost-reasons/{id}	Updates the LeadLostReason resource.
DELETE	/lead-lost-reasons/{id}	Removes the LeadLostReason resource.

Schema fields

Field	Type	Description
id	string
label*	string

Lead Stage

Endpoints

GET	/lead-stages	Retrieves the collection of LeadStage resources.
POST	/lead-stages	Creates a LeadStage resource.
GET	/lead-stages/{id}	Retrieves a LeadStage resource.
PATCH	/lead-stages/{id}	Updates the LeadStage resource.
DELETE	/lead-stages/{id}	Removes the LeadStage resource.

Schema fields

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

Lead Stage History

Endpoints

GET	/lead-stage-histories	Retrieves the collection of LeadStageHistory resources.
GET	/lead-stage-histories/{id}	Retrieves a LeadStageHistory resource.

Schema fields

Field	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)

CRM Note

Endpoints

GET	/crm-notes	Retrieves the collection of CrmNote resources.
POST	/crm-notes	Creates a CrmNote resource.
GET	/crm-notes/{id}	Retrieves a CrmNote resource.
PATCH	/crm-notes/{id}	Updates the CrmNote resource.
DELETE	/crm-notes/{id}	Removes the CrmNote resource.

Schema fields

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

PipeDrive Lead

Endpoints

GET	/pipe-drive-leads	Retrieves the collection of PipeDriveLead resources.
GET	/pipe-drive-leads/summary	Retrieves the collection of PipeDriveLead resources.

Schema fields

Field	Type	Description
id	string
type	string
title	string