Skip to content

Leads TCP API

Lead is a pre-customer CRM entity. It is converted to Customer explicitly and does not have customer auth, KYC/AML lifecycle, or account binding by default.

Access Control

All lead methods require one of:

  • SESSION_MANAGER
  • SESSION_ADMIN
  • SESSION_DEALER
  • SESSION_CRM_MANAGER
  • SESSION_CRM_ADMIN

Core Fields

Field Type Description
lead_id int Lead id
brand string Brand namespace
desk_id int Desk id
manager_id int Current owner manager
assigned_manager_id int Pending assignment manager
type int 0 individual, 1 business
status int 0 new, 1 in progress, 2 qualified, 3 unqualified, 4 converted, 5 archived
source_type int 0 manual, 1 web, 2 import, 3 affiliate, 4 system
email string Lead email
phone string Lead phone
sales_status, finance_status, risk_status int CRM status dictionary ids
converted_customer_id int Created customer id after conversion
created_time, updated_time, archive_time, conversion_time time_t Lead lifecycle timestamps

Commands