Polska firma — tworzymy w Polsce

CRM — leady i szanse sprzedaży

Leady, szanse sprzedaży, pipeline'y i etapy — prowadź lejek sprzedaży z własnych systemów.

Ta dokumentacja jest generowana ze schematu API. Opisy pól oraz wszelkie teksty, które nie zostały jeszcze przetłumaczone, są wyświetlane po angielsku.

Szansa sprzedaży

Endpoints

Szansa sprzedaży: Endpoints
Metoda	Ścieżka	Opis
GET	/deals	Pobiera kolekcję zasobów Deal.
POST	/deals	Tworzy zasób Deal.
GET	/deals/{id}	Pobiera zasób Deal.
PATCH	/deals/{id}	Aktualizuje zasób Deal.
DELETE	/deals/{id}	Usuwa zasób 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.

Pola schematu

Szansa sprzedaży: Pola schematu
Pole	Typ	Opis
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

Lead: Endpoints
Metoda	Ścieżka	Opis
GET	/leads	Pobiera kolekcję zasobów Lead.
POST	/leads	Tworzy zasób Lead.
GET	/leads/{id}	Pobiera zasób Lead.
PATCH	/leads/{id}	Aktualizuje zasób Lead.
DELETE	/leads/{id}	Usuwa zasób 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.

Pola schematu

Lead: Pola schematu
Pole	Typ	Opis
id	string
companyName	stringnull

Pipeline

Endpoints

Pipeline: Endpoints
Metoda	Ścieżka	Opis
GET	/pipelines	Pobiera kolekcję zasobów Pipeline.
POST	/pipelines	Tworzy zasób Pipeline.
GET	/pipelines/{id}	Pobiera zasób Pipeline.
PATCH	/pipelines/{id}	Aktualizuje zasób Pipeline.
DELETE	/pipelines/{id}	Usuwa zasób Pipeline.

Pola schematu

Pipeline: Pola schematu
Pole	Typ	Opis
id	string
name*	string
isDefault	boolean
stages	array

Etap

Endpoints

Etap: Endpoints
Metoda	Ścieżka	Opis
GET	/stages	Pobiera kolekcję zasobów Stage.
POST	/stages	Tworzy zasób Stage.
GET	/stages/{id}	Pobiera zasób Stage.
PATCH	/stages/{id}	Aktualizuje zasób Stage.
DELETE	/stages/{id}	Usuwa zasób Stage.

Pola schematu

Etap: Pola schematu
Pole	Typ	Opis
id	string
name*	string
position	integer
probability	integer
isWon	boolean
isLost	boolean

Powód utraty szansy sprzedaży

Endpoints

Powód utraty szansy sprzedaży: Endpoints
Metoda	Ścieżka	Opis
GET	/deal-lost-reasons	Pobiera kolekcję zasobów DealLostReason.
POST	/deal-lost-reasons	Tworzy zasób DealLostReason.
GET	/deal-lost-reasons/{id}	Pobiera zasób DealLostReason.
PATCH	/deal-lost-reasons/{id}	Aktualizuje zasób DealLostReason.
DELETE	/deal-lost-reasons/{id}	Usuwa zasób DealLostReason.

Pola schematu

Powód utraty szansy sprzedaży: Pola schematu
Pole	Typ	Opis
id	string
label*	string

Historia etapów szansy sprzedaży

Endpoints

Historia etapów szansy sprzedaży: Endpoints
Metoda	Ścieżka	Opis
GET	/deal-stage-histories	Pobiera kolekcję zasobów DealStageHistory.
GET	/deal-stage-histories/{id}	Pobiera zasób DealStageHistory.

Pola schematu

Historia etapów szansy sprzedaży: Pola schematu
Pole	Typ	Opis
id	string
fromStage	mixed
toStage	mixed
changedAt	string (date-time)
changedBy	mixed

Aktywność leada

Endpoints

Aktywność leada: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-activities	Pobiera kolekcję zasobów LeadActivity.
POST	/lead-activities	Tworzy zasób LeadActivity.
GET	/lead-activities/{id}	Pobiera zasób LeadActivity.
PATCH	/lead-activities/{id}	Aktualizuje zasób LeadActivity.
DELETE	/lead-activities/{id}	Usuwa zasób LeadActivity.

Pola schematu

Aktywność leada: Pola schematu
Pole	Typ	Opis
lead*	string (iri-reference)
contact	string,null (iri-reference)
wave	string,null (iri-reference)
type*	string
channel	stringnull
occurredAt*	string (date-time)
body	stringnull
externalId	stringnull
threadId	stringnull
fromMailbox	stringnull

Kontakt leada

Endpoints

Kontakt leada: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-contacts	Pobiera kolekcję zasobów LeadContact.
POST	/lead-contacts	Tworzy zasób LeadContact.
GET	/lead-contacts/{id}	Pobiera zasób LeadContact.
PATCH	/lead-contacts/{id}	Aktualizuje zasób LeadContact.
DELETE	/lead-contacts/{id}	Usuwa zasób LeadContact.

Pola schematu

Kontakt leada: Pola schematu
Pole	Typ	Opis
id	string
name*	string
email	stringnull
phone	stringnull
linkedinUrl	stringnull
role	stringnull
isPrimary	boolean

Lista leadów

Endpoints

Lista leadów: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-lists	Pobiera kolekcję zasobów LeadList.
POST	/lead-lists	Tworzy zasób LeadList.
GET	/lead-lists/{id}	Pobiera zasób LeadList.
PATCH	/lead-lists/{id}	Aktualizuje zasób LeadList.
DELETE	/lead-lists/{id}	Usuwa zasób LeadList.

Pola schematu

Lista leadów: Pola schematu
Pole	Typ	Opis
id	string
name*	string
description	stringnull
owner	string,null (iri-reference)
channel	stringnull
status	string
segment	stringnull
memberships	array

Przynależność leada do listy

Endpoints

Przynależność leada do listy: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-list-memberships	Pobiera kolekcję zasobów LeadListMembership.
POST	/lead-list-memberships	Tworzy zasób LeadListMembership.
GET	/lead-list-memberships/{id}	Pobiera zasób LeadListMembership.
PATCH	/lead-list-memberships/{id}	Aktualizuje zasób LeadListMembership.
DELETE	/lead-list-memberships/{id}	Usuwa zasób LeadListMembership.

Pola schematu

Przynależność leada do listy: Pola schematu
Pole	Typ	Opis
id	string
list*	object
lead*	string (iri-reference)
status	string
addedAt	string (date-time)
lastContactedAt	string,null (date-time)

Powód utraty leada

Endpoints

Powód utraty leada: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-lost-reasons	Pobiera kolekcję zasobów LeadLostReason.
POST	/lead-lost-reasons	Tworzy zasób LeadLostReason.
GET	/lead-lost-reasons/{id}	Pobiera zasób LeadLostReason.
PATCH	/lead-lost-reasons/{id}	Aktualizuje zasób LeadLostReason.
DELETE	/lead-lost-reasons/{id}	Usuwa zasób LeadLostReason.

Pola schematu

Powód utraty leada: Pola schematu
Pole	Typ	Opis
id	string
label*	string

Etap leada

Endpoints

Etap leada: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-stages	Pobiera kolekcję zasobów LeadStage.
POST	/lead-stages	Tworzy zasób LeadStage.
GET	/lead-stages/{id}	Pobiera zasób LeadStage.
PATCH	/lead-stages/{id}	Aktualizuje zasób LeadStage.
DELETE	/lead-stages/{id}	Usuwa zasób LeadStage.

Pola schematu

Etap leada: Pola schematu
Pole	Typ	Opis
id	string
label*	string
position	integer	Sort key only — ties are legitimate and broken by label (see class docblock).

Historia etapów leada

Endpoints

Historia etapów leada: Endpoints
Metoda	Ścieżka	Opis
GET	/lead-stage-histories	Pobiera kolekcję zasobów LeadStageHistory.
GET	/lead-stage-histories/{id}	Pobiera zasób LeadStageHistory.

Pola schematu

Historia etapów leada: Pola schematu
Pole	Typ	Opis
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)

Notatka CRM

Endpoints

Notatka CRM: Endpoints
Metoda	Ścieżka	Opis
GET	/crm-notes	Pobiera kolekcję zasobów CrmNote.
POST	/crm-notes	Tworzy zasób CrmNote.
GET	/crm-notes/{id}	Pobiera zasób CrmNote.
PATCH	/crm-notes/{id}	Aktualizuje zasób CrmNote.
DELETE	/crm-notes/{id}	Usuwa zasób CrmNote.

Pola schematu

Notatka CRM: Pola schematu
Pole	Typ	Opis
body*	string
lead	string,null (iri-reference)
deal	string,null (iri-reference)

Lead z PipeDrive

Endpoints

Lead z PipeDrive: Endpoints
Metoda	Ścieżka	Opis
GET	/pipe-drive-leads	Pobiera kolekcję zasobów PipeDriveLead.
GET	/pipe-drive-leads/summary	Pobiera kolekcję zasobów PipeDriveLead.

Pola schematu

Lead z PipeDrive: Pola schematu
Pole	Typ	Opis
id	string
type	string
title	string

Fala kampanii

Endpoints

Fala kampanii: Endpoints
Metoda	Ścieżka	Opis
GET	/campaign-waves	Pobiera kolekcję zasobów CampaignWave.
POST	/campaign-waves	Tworzy zasób CampaignWave.
GET	/campaign-waves/{id}	Pobiera zasób CampaignWave.
PATCH	/campaign-waves/{id}	Aktualizuje zasób CampaignWave.
DELETE	/campaign-waves/{id}	Usuwa zasób CampaignWave.

Pola schematu

Fala kampanii: Pola schematu
Pole	Typ	Opis
id	string
list*	string (iri-reference)
number*	integer
label	stringnull
status*	string
plannedAt	string,null (date-time)
sentAt	string,null (date-time)
plannedRecipientCount	integernull