CRM — leads & deals

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

Această referință este generată din schema API. Descrierile câmpurilor și orice text încă netradus sunt afișate în engleză.

Deal

Endpoints

Deal: Endpoints
MethodPath
GET/deals
POST/deals
GET/deals/{id}
PATCH/deals/{id}
DELETE/deals/{id}
POST/deals/{id}/lose
POST/deals/{id}/reopen
POST/deals/{id}/win

Schema fields

Deal: Schema fields
FieldType
idstring
title*string
clientmixed
contactmixed
stage*object
amountMinorstringnull
currencymixed
expectedCloseDatestring,null (date-time)
statusstring
closedAtstring,null (date-time)
lostReasonmixed
lostReasonNotestringnull
ownermixed
leadmixed
contractstring,null (iri-reference)
stageHistoryarray
createdAtstring (date-time)
updatedAtstring (date-time)

Lead

Endpoints

Lead: Endpoints
MethodPath
GET/leads
POST/leads
GET/leads/{id}
PATCH/leads/{id}
DELETE/leads/{id}
POST/leads/{id}/convert
POST/leads/{id}/lose
POST/leads/{id}/reopen
GET/leads/dedupe-check

Schema fields

Lead: Schema fields
FieldType
idstring
companyNamestringnull

Pipeline

Endpoints

Pipeline: Endpoints
MethodPath
GET/pipelines
POST/pipelines
GET/pipelines/{id}
PATCH/pipelines/{id}
DELETE/pipelines/{id}

Schema fields

Pipeline: Schema fields
FieldType
idstring
name*string
isDefaultboolean
stagesarray

Stage

Endpoints

Stage: Endpoints
MethodPath
GET/stages
POST/stages
GET/stages/{id}
PATCH/stages/{id}
DELETE/stages/{id}

Schema fields

Stage: Schema fields
FieldType
idstring
name*string
positioninteger
probabilityinteger
isWonboolean
isLostboolean

Deal Lost Reason

Endpoints

Deal Lost Reason: Endpoints
MethodPath
GET/deal-lost-reasons
POST/deal-lost-reasons
GET/deal-lost-reasons/{id}
PATCH/deal-lost-reasons/{id}
DELETE/deal-lost-reasons/{id}

Schema fields

Deal Lost Reason: Schema fields
FieldType
idstring
label*string

Deal Stage History

Endpoints

Deal Stage History: Endpoints
MethodPath
GET/deal-stage-histories
GET/deal-stage-histories/{id}

Schema fields

Deal Stage History: Schema fields
FieldType
idstring
fromStagemixed
toStagemixed
changedAtstring (date-time)
changedBymixed

Lead Activity

Endpoints

Lead Activity: Endpoints
MethodPath
GET/lead-activities
POST/lead-activities
GET/lead-activities/{id}
PATCH/lead-activities/{id}
DELETE/lead-activities/{id}

Schema fields

Lead Activity: Schema fields
FieldType
lead*string (iri-reference)
contactstring,null (iri-reference)
wavestring,null (iri-reference)
type*string
channelstringnull
occurredAt*string (date-time)
bodystringnull
externalIdstringnull
threadIdstringnull
fromMailboxstringnull

Lead Contact

Endpoints

Lead Contact: Endpoints
MethodPath
GET/lead-contacts
POST/lead-contacts
GET/lead-contacts/{id}
PATCH/lead-contacts/{id}
DELETE/lead-contacts/{id}

Schema fields

Lead Contact: Schema fields
FieldType
idstring
name*string
emailstringnull
phonestringnull
linkedinUrlstringnull
rolestringnull
isPrimaryboolean

Lead List

Endpoints

Lead List: Endpoints
MethodPath
GET/lead-lists
POST/lead-lists
GET/lead-lists/{id}
PATCH/lead-lists/{id}
DELETE/lead-lists/{id}

Schema fields

Lead List: Schema fields
FieldType
idstring
name*string
descriptionstringnull
ownerstring,null (iri-reference)
channelstringnull
statusstring
segmentstringnull
membershipsarray

Lead List Membership

Endpoints

Lead List Membership: Endpoints
MethodPath
GET/lead-list-memberships
POST/lead-list-memberships
GET/lead-list-memberships/{id}
PATCH/lead-list-memberships/{id}
DELETE/lead-list-memberships/{id}

Schema fields

Lead List Membership: Schema fields
FieldType
idstring
list*object
lead*string (iri-reference)
statusstring
addedAtstring (date-time)
lastContactedAtstring,null (date-time)

Lead Lost Reason

Endpoints

Lead Lost Reason: Endpoints
MethodPath
GET/lead-lost-reasons
POST/lead-lost-reasons
GET/lead-lost-reasons/{id}
PATCH/lead-lost-reasons/{id}
DELETE/lead-lost-reasons/{id}

Schema fields

Lead Lost Reason: Schema fields
FieldType
idstring
label*string

Lead Stage

Endpoints

Lead Stage: Endpoints
MethodPath
GET/lead-stages
POST/lead-stages
GET/lead-stages/{id}
PATCH/lead-stages/{id}
DELETE/lead-stages/{id}

Schema fields

Lead Stage: Schema fields
FieldType
idstring
label*string
positioninteger

Lead Stage History

Endpoints

Lead Stage History: Endpoints
MethodPath
GET/lead-stage-histories
GET/lead-stage-histories/{id}

Schema fields

Lead Stage History: Schema fields
FieldType
idstring
leadstring (iri-reference)
fromStagestring,null (iri-reference)
toStagestring,null (iri-reference)
changedAtstring (date-time)
changedBystring,null (iri-reference)

CRM Note

Endpoints

CRM Note: Endpoints
MethodPath
GET/crm-notes
POST/crm-notes
GET/crm-notes/{id}
PATCH/crm-notes/{id}
DELETE/crm-notes/{id}

Schema fields

CRM Note: Schema fields
FieldType
body*string
leadstring,null (iri-reference)
dealstring,null (iri-reference)

PipeDrive Lead

Endpoints

PipeDrive Lead: Endpoints
MethodPath
GET/pipe-drive-leads
GET/pipe-drive-leads/summary

Schema fields

PipeDrive Lead: Schema fields
FieldType
idstring
typestring
titlestring

Campaign Wave

Endpoints

Campaign Wave: Endpoints
MethodPath
GET/campaign-waves
POST/campaign-waves
GET/campaign-waves/{id}
PATCH/campaign-waves/{id}
DELETE/campaign-waves/{id}

Schema fields

Campaign Wave: Schema fields
FieldType
idstring
list*string (iri-reference)
number*integer
labelstringnull
status*string
plannedAtstring,null (date-time)
sentAtstring,null (date-time)
plannedRecipientCountintegernull