CRM — leads e negócios

Leads, negócios, pipelines e fases — conduza o funil de vendas a partir dos seus próprios sistemas.

Negócio

Endpoints

GET	/deals	Recupera a coleção de recursos Deal.
POST	/deals	Cria um recurso Deal.
GET	/deals/{id}	Recupera um recurso Deal.
PATCH	/deals/{id}	Atualiza o recurso Deal.
DELETE	/deals/{id}	Remove o recurso 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.

Campos de schema

Campo	Tipo	Descrição
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)

Lead

Endpoints

GET	/leads	Recupera a coleção de recursos Lead.
POST	/leads	Cria um recurso Lead.
GET	/leads/{id}	Recupera um recurso Lead.
PATCH	/leads/{id}	Atualiza o recurso Lead.
DELETE	/leads/{id}	Remove o recurso 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.

Campos de schema

Campo	Tipo	Descrição
id	string
companyName	stringnull

Pipeline

Endpoints

GET	/pipelines	Recupera a coleção de recursos Pipeline.
POST	/pipelines	Cria um recurso Pipeline.
GET	/pipelines/{id}	Recupera um recurso Pipeline.
PATCH	/pipelines/{id}	Atualiza o recurso Pipeline.
DELETE	/pipelines/{id}	Remove o recurso Pipeline.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
isDefault	boolean
stages	array

Fase

Endpoints

GET	/stages	Recupera a coleção de recursos Stage.
POST	/stages	Cria um recurso Stage.
GET	/stages/{id}	Recupera um recurso Stage.
PATCH	/stages/{id}	Atualiza o recurso Stage.
DELETE	/stages/{id}	Remove o recurso Stage.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
position	integer
probability	integer
isWon	boolean
isLost	boolean

Motivo de Perda do Negócio

Endpoints

GET	/deal-lost-reasons	Recupera a coleção de recursos DealLostReason.
POST	/deal-lost-reasons	Cria um recurso DealLostReason.
GET	/deal-lost-reasons/{id}	Recupera um recurso DealLostReason.
PATCH	/deal-lost-reasons/{id}	Atualiza o recurso DealLostReason.
DELETE	/deal-lost-reasons/{id}	Remove o recurso DealLostReason.

Campos de schema

Campo	Tipo	Descrição
id	string
label*	string

Histórico de Fases do Negócio

Endpoints

GET	/deal-stage-histories	Recupera a coleção de recursos DealStageHistory.
GET	/deal-stage-histories/{id}	Recupera um recurso DealStageHistory.

Campos de schema

Campo	Tipo	Descrição
id	string
fromStage	mixed
toStage	mixed
changedAt	string (date-time)
changedBy	mixed

Atividade do Lead

Endpoints

GET	/lead-activities	Recupera a coleção de recursos LeadActivity.
POST	/lead-activities	Cria um recurso LeadActivity.
GET	/lead-activities/{id}	Recupera um recurso LeadActivity.
PATCH	/lead-activities/{id}	Atualiza o recurso LeadActivity.
DELETE	/lead-activities/{id}	Remove o recurso LeadActivity.

Campos de schema

Campo	Tipo	Descrição
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

Contacto do Lead

Endpoints

GET	/lead-contacts	Recupera a coleção de recursos LeadContact.
POST	/lead-contacts	Cria um recurso LeadContact.
GET	/lead-contacts/{id}	Recupera um recurso LeadContact.
PATCH	/lead-contacts/{id}	Atualiza o recurso LeadContact.
DELETE	/lead-contacts/{id}	Remove o recurso LeadContact.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
email	stringnull
phone	stringnull
linkedinUrl	stringnull
role	stringnull
isPrimary	boolean

Lista de Leads

Endpoints

GET	/lead-lists	Recupera a coleção de recursos LeadList.
POST	/lead-lists	Cria um recurso LeadList.
GET	/lead-lists/{id}	Recupera um recurso LeadList.
PATCH	/lead-lists/{id}	Atualiza o recurso LeadList.
DELETE	/lead-lists/{id}	Remove o recurso LeadList.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
description	stringnull
owner	string,null (iri-reference)
channel	stringnull
status	string
segment	stringnull
memberships	array

Associação a Lista de Leads

Endpoints

GET	/lead-list-memberships	Recupera a coleção de recursos LeadListMembership.
POST	/lead-list-memberships	Cria um recurso LeadListMembership.
GET	/lead-list-memberships/{id}	Recupera um recurso LeadListMembership.
PATCH	/lead-list-memberships/{id}	Atualiza o recurso LeadListMembership.
DELETE	/lead-list-memberships/{id}	Remove o recurso LeadListMembership.

Campos de schema

Campo	Tipo	Descrição
id	string
list*	object
lead*	string (iri-reference)
status	string
addedAt	string (date-time)
lastContactedAt	string,null (date-time)

Motivo de Perda do Lead

Endpoints

GET	/lead-lost-reasons	Recupera a coleção de recursos LeadLostReason.
POST	/lead-lost-reasons	Cria um recurso LeadLostReason.
GET	/lead-lost-reasons/{id}	Recupera um recurso LeadLostReason.
PATCH	/lead-lost-reasons/{id}	Atualiza o recurso LeadLostReason.
DELETE	/lead-lost-reasons/{id}	Remove o recurso LeadLostReason.

Campos de schema

Campo	Tipo	Descrição
id	string
label*	string

Fase do Lead

Endpoints

GET	/lead-stages	Recupera a coleção de recursos LeadStage.
POST	/lead-stages	Cria um recurso LeadStage.
GET	/lead-stages/{id}	Recupera um recurso LeadStage.
PATCH	/lead-stages/{id}	Atualiza o recurso LeadStage.
DELETE	/lead-stages/{id}	Remove o recurso LeadStage.

Campos de schema

Campo	Tipo	Descrição
id	string
label*	string
position	integer	Sort key only — ties are legitimate and broken by label (see class docblock).

Histórico de Fases do Lead

Endpoints

GET	/lead-stage-histories	Recupera a coleção de recursos LeadStageHistory.
GET	/lead-stage-histories/{id}	Recupera um recurso LeadStageHistory.

Campos de schema

Campo	Tipo	Descrição
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)

Nota de CRM

Endpoints

GET	/crm-notes	Recupera a coleção de recursos CrmNote.
POST	/crm-notes	Cria um recurso CrmNote.
GET	/crm-notes/{id}	Recupera um recurso CrmNote.
PATCH	/crm-notes/{id}	Atualiza o recurso CrmNote.
DELETE	/crm-notes/{id}	Remove o recurso CrmNote.

Campos de schema

Campo	Tipo	Descrição
body*	string
lead	string,null (iri-reference)
deal	string,null (iri-reference)

Lead do PipeDrive

Endpoints

GET	/pipe-drive-leads	Recupera a coleção de recursos PipeDriveLead.
GET	/pipe-drive-leads/summary	Recupera a coleção de recursos PipeDriveLead.

Campos de schema

Campo	Tipo	Descrição
id	string
type	string
title	string