CRM — ліди та угоди

Ліди, угоди, воронки та етапи — керуйте вирвою продажів зі своїх систем.

Угода

Endpoints

GET	/deals	Отримує колекцію ресурсів Deal.
POST	/deals	Створює ресурс Deal.
GET	/deals/{id}	Отримує ресурс Deal.
PATCH	/deals/{id}	Оновлює ресурс Deal.
DELETE	/deals/{id}	Видаляє ресурс 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.

Поля схеми

Поле	Тип	Опис
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)

Лід

Endpoints

GET	/leads	Отримує колекцію ресурсів Lead.
POST	/leads	Створює ресурс Lead.
GET	/leads/{id}	Отримує ресурс Lead.
PATCH	/leads/{id}	Оновлює ресурс Lead.
DELETE	/leads/{id}	Видаляє ресурс 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.

Поля схеми

Поле	Тип	Опис
id	string
companyName	stringnull

Воронка продажів

Endpoints

GET	/pipelines	Отримує колекцію ресурсів Pipeline.
POST	/pipelines	Створює ресурс Pipeline.
GET	/pipelines/{id}	Отримує ресурс Pipeline.
PATCH	/pipelines/{id}	Оновлює ресурс Pipeline.
DELETE	/pipelines/{id}	Видаляє ресурс Pipeline.

Поля схеми

Поле	Тип	Опис
id	string
name*	string
isDefault	boolean
stages	array

Етап

Endpoints

GET	/stages	Отримує колекцію ресурсів Stage.
POST	/stages	Створює ресурс Stage.
GET	/stages/{id}	Отримує ресурс Stage.
PATCH	/stages/{id}	Оновлює ресурс Stage.
DELETE	/stages/{id}	Видаляє ресурс Stage.

Поля схеми

Поле	Тип	Опис
id	string
name*	string
position	integer
probability	integer
isWon	boolean
isLost	boolean

Причина втрати угоди

Endpoints

GET	/deal-lost-reasons	Отримує колекцію ресурсів DealLostReason.
POST	/deal-lost-reasons	Створює ресурс DealLostReason.
GET	/deal-lost-reasons/{id}	Отримує ресурс DealLostReason.
PATCH	/deal-lost-reasons/{id}	Оновлює ресурс DealLostReason.
DELETE	/deal-lost-reasons/{id}	Видаляє ресурс DealLostReason.

Поля схеми

Поле	Тип	Опис
id	string
label*	string

Історія етапів угоди

Endpoints

GET	/deal-stage-histories	Отримує колекцію ресурсів DealStageHistory.
GET	/deal-stage-histories/{id}	Отримує ресурс DealStageHistory.

Поля схеми

Поле	Тип	Опис
id	string
fromStage	mixed
toStage	mixed
changedAt	string (date-time)
changedBy	mixed

Активність ліда

Endpoints

GET	/lead-activities	Отримує колекцію ресурсів LeadActivity.
POST	/lead-activities	Створює ресурс LeadActivity.
GET	/lead-activities/{id}	Отримує ресурс LeadActivity.
PATCH	/lead-activities/{id}	Оновлює ресурс LeadActivity.
DELETE	/lead-activities/{id}	Видаляє ресурс LeadActivity.

Поля схеми

Поле	Тип	Опис
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

Контакт ліда

Endpoints

GET	/lead-contacts	Отримує колекцію ресурсів LeadContact.
POST	/lead-contacts	Створює ресурс LeadContact.
GET	/lead-contacts/{id}	Отримує ресурс LeadContact.
PATCH	/lead-contacts/{id}	Оновлює ресурс LeadContact.
DELETE	/lead-contacts/{id}	Видаляє ресурс LeadContact.

Поля схеми

Поле	Тип	Опис
id	string
name*	string
email	stringnull
phone	stringnull
linkedinUrl	stringnull
role	stringnull
isPrimary	boolean

Список лідів

Endpoints

GET	/lead-lists	Отримує колекцію ресурсів LeadList.
POST	/lead-lists	Створює ресурс LeadList.
GET	/lead-lists/{id}	Отримує ресурс LeadList.
PATCH	/lead-lists/{id}	Оновлює ресурс LeadList.
DELETE	/lead-lists/{id}	Видаляє ресурс LeadList.

Поля схеми

Поле	Тип	Опис
id	string
name*	string
description	stringnull
owner	string,null (iri-reference)
channel	stringnull
status	string
segment	stringnull
memberships	array

Членство ліда у списку

Endpoints

GET	/lead-list-memberships	Отримує колекцію ресурсів LeadListMembership.
POST	/lead-list-memberships	Створює ресурс LeadListMembership.
GET	/lead-list-memberships/{id}	Отримує ресурс LeadListMembership.
PATCH	/lead-list-memberships/{id}	Оновлює ресурс LeadListMembership.
DELETE	/lead-list-memberships/{id}	Видаляє ресурс LeadListMembership.

Поля схеми

Поле	Тип	Опис
id	string
list*	object
lead*	string (iri-reference)
status	string
addedAt	string (date-time)
lastContactedAt	string,null (date-time)

Причина втрати ліда

Endpoints

GET	/lead-lost-reasons	Отримує колекцію ресурсів LeadLostReason.
POST	/lead-lost-reasons	Створює ресурс LeadLostReason.
GET	/lead-lost-reasons/{id}	Отримує ресурс LeadLostReason.
PATCH	/lead-lost-reasons/{id}	Оновлює ресурс LeadLostReason.
DELETE	/lead-lost-reasons/{id}	Видаляє ресурс LeadLostReason.

Поля схеми

Поле	Тип	Опис
id	string
label*	string

Етап ліда

Endpoints

GET	/lead-stages	Отримує колекцію ресурсів LeadStage.
POST	/lead-stages	Створює ресурс LeadStage.
GET	/lead-stages/{id}	Отримує ресурс LeadStage.
PATCH	/lead-stages/{id}	Оновлює ресурс LeadStage.
DELETE	/lead-stages/{id}	Видаляє ресурс LeadStage.

Поля схеми

Поле	Тип	Опис
id	string
label*	string
position	integer	Sort key only — ties are legitimate and broken by label (see class docblock).

Історія етапів ліда

Endpoints

GET	/lead-stage-histories	Отримує колекцію ресурсів LeadStageHistory.
GET	/lead-stage-histories/{id}	Отримує ресурс LeadStageHistory.

Поля схеми

Поле	Тип	Опис
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

Endpoints

GET	/crm-notes	Отримує колекцію ресурсів CrmNote.
POST	/crm-notes	Створює ресурс CrmNote.
GET	/crm-notes/{id}	Отримує ресурс CrmNote.
PATCH	/crm-notes/{id}	Оновлює ресурс CrmNote.
DELETE	/crm-notes/{id}	Видаляє ресурс CrmNote.

Поля схеми

Поле	Тип	Опис
body*	string
lead	string,null (iri-reference)
deal	string,null (iri-reference)

Лід PipeDrive

Endpoints

GET	/pipe-drive-leads	Отримує колекцію ресурсів PipeDriveLead.
GET	/pipe-drive-leads/summary	Отримує колекцію ресурсів PipeDriveLead.

Поля схеми

Поле	Тип	Опис
id	string
type	string
title	string