Leads

lead

Description

This is one of the general entities of the CRM. Each lead can be linked to one or more contacts, or to none.

A responsible user may be assigned to each lead in order to assign access privileges among the account’s personnel.

Each lead has a status, which specifies the current position of the lead within its lifecycle (pipeline or business process). Stage must be necessarily assigned to any lead. The Pipeline stages can be changed except for two final system statuses (Won and Lost).

Fields

Field Type Description
General fileds
id Integer Entry id
name String Lead title
description Text Lead description
budget Double Lead budget
company_id Integer Account id (for Organizations)
contact_id Integer Account id (for Contacts)
source_id Integer Id of entry from Lead Sources table
assignee_id Integer Assigned user id
Lead Time Frame
start_date Date Date of start of lead processing
deadline Date Plan date of lead closing
Lead Health Fields
pipeline_id Integer Pipeline id
pipeline_stage_id Integer Pipeline stage id
active Boolean (Integer 0 or 1) Lead health status
1 - lead in progress;
2 - lead is lost;
3 - lead is won;
closing_date Date Date of lead closing (fills if lead has active = 2 or 3)
closing_comment Text Comment or note describes reason or situation
closing_status_id Integer Id of entry in Loss Reasons table
Lead Contact fields
contact_name Text Contact name
contact_phone String Contact phone
contact_mobile String Contact mobile phone (or additional phone)
contact_email String Contact email
contact_web String Website
contact_position String Contact position
contact_company String Contact company (organization)
System Service Fields
ref String Name of the import source of the object (system, etc.)
ref_id Integer UUID in the system from where the import was made.

Examples

create:

curl -H "Content-Type: application/json" -X POST -d {"name":"String","description":"Text"} https://company.flowlu.ru/api/v1/module/crm/lead/create/?api_key=<api_key>

update:

curl -H "Content-Type: application/json" -X POST -d {"name":"String","description":"Text"} https://company.flowlu.ru/api/v1/module/crm/lead/update/1?api_key=<api_key>

get:

curl -X GET https://company.flowlu.ru/api/v1/module/crm/lead/get/1?api_key=<api_key>

delete:

curl -X GET https://company.flowlu.ru/api/v1/module/crm/lead/delete/1?api_key=<api_key>

list:

curl -X GET https://company.flowlu.ru/api/v1/module/crm/lead/list?search=flowlu&page=1&api_key=<api_key>