The Lead

A lead is a client entity with lead status. The same entityKey is used after you convert the lead to an Active client.

A lead is an entity in the lead pipeline. Create with POST /api/v1/leads. Convert with POST /api/v1/leads/{entityKey}/convert-to-client. Conversion sets status from Lead to Active. The entityKey does not change. 400 if the entity is already a client.

Resolve type, source, and status names from settings before you create:

Route	Field
GET /api/v1/settings/entity-types	entityType / entityTypeID
GET /api/v1/settings/lead-sources	leadSource name
GET /api/v1/settings/lead-statuses	leadStatus name

See Leads and deals.

Attributes

entityKey · uuid

Same identifier used for Active clients after conversion.

entityType · string

Type name such as Individual or Company.

entityName · string

Given name for individuals, or the legal / trading name for companies.

entitySurname · string

Family name for individuals and sole traders. Leave unset for companies.

leadSource · string

Source name from practice settings, not an id.

leadStatus · string

Status name from practice settings, not an id.

The Lead

{
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "entityType": "Individual",
  "entityName": "Alex",
  "entitySurname": "Morgan",
  "email": "[e-mail]",
  "leadSource": "Website enquiry",
  "leadStatus": "New"
}