DemandFlow Support Centre

LEAD: Lead

A CRM lead representing a person being pursued as a sales prospect.

Default definition. This article describes the default LEAD definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches LEAD.

Entity properties

Property	Value
Entity code	`LEAD`
Display name	Lead
Plural	Leads
Level	220
Extends	`PPL`. See Entity Extension.

Use cases

LEAD is a CRM/sales overlay of PPL. While PPL is the canonical contact record, LEAD captures the sales pipeline context: who owns the lead, what stage it's at in qualification, how it was sourced, and which account it's associated with. A LEAD always links back to a PPL record via df_extendObject.

Fields

Because this entity extends PPL, some fields may actually be stored on the linked base record rather than on this record directly. See Entity Extension.

Lead Details

Field	Type	Required	Notes
`nameFirst`	text	Yes	First Name
`nameLast`	text	Yes	Last Name
`df_extendObject`	reference → `PPL`		Contact record
`email`	text		Email
`phone`	text		Phone
`job`	text		Job Title

Sales Pipeline

Field	Type	Notes
`leadOwner`	reference → user	Lead Owner
`leadStatus`	enum	Status Valid ids: `new` (New), `contacted` (Contacted), `qualified` (Qualified), `proposal` (Proposal), `won` (Won), `lost` (Lost), `disqualified` (Disqualified).
`leadSource`	enum	Lead Source Valid ids: `inbound` (Inbound), `outbound` (Outbound), `referral` (Referral), `event` (Event), `website` (Website), `partner` (Partner), `other` (Other).
`qualificationScore`	number	Qualification Score
`account`	reference → `ACCOUNT`	Account
`company`	reference → `COM`	Company

Engagement

Field	Type	Notes
`lastContactDate`	date	Last Contacted
`nextFollowUp`	date	Next Follow-up
`lostReason`	text (multi-line)	Lost/Disqualified Reason
`description`	text (multi-line)	Notes

Activity. Activity timeline panel attached.

Relationships

Lookups: df_extendObject points at a PPL record. account points at a ACCOUNT record. company points at a COM record.
Extends: this entity extends PPL. See Entity Extension.

Creating a Lead via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "LEAD",
  "level":    220,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "nameFirst": "Ada",
  "nameLast": "Lovelace",
  "df_extendObject": "",
  "email": "name@example.com"
}

Listing Leads records

# All leads in your tenant
GET /v1/entities/LEAD/SUB

DemandFlow Support Centre

LEAD: Lead

LEAD: Lead

Entity properties

Use cases

Fields

Relationships

Creating a Lead via the API

Listing Leads records

See also

Was this article helpful?