Create lead

Create a new lead. Requires the leads:write scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid | null

The pipeline stage to create the lead in - one of the stages with isOpen: true from GET /api/v1/lead-stages. Takes precedence over the deprecated lane field when both are sent; an id that does not resolve to an open stage owned by the practice falls back to the first open stage.

string
enum
Defaults to enquiry
deprecated

Deprecated - use stage_id instead. Maps to the practice's matching pipeline stage; when that stage has been removed the lead lands in the first stage of the pipeline

Allowed:
string
length ≤ 255

A descriptive title for this lead

string
enum
Defaults to warm

How likely this lead is to convert

Allowed:
string

Where this lead came from. Omit it and the practice's configured default source is applied; there is no fixed default value, because each firm chooses its own.

string | null

Detail about the source. Some sources are configured to require it - the 422 names the source and says, in the firm's own words, what it expects here.

string
enum

Expected size of this deal

Allowed:
client
object
required
contact
object
required
uuid

ID of the team member who owns this lead

note
object

An optional opening note to record against the new lead - somewhere for a long free-text answer from your intake form to land.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json