Update lead

patch

https://app.usesocket.com/api/v1/leads/{lead}

Update the lead's own details. Only the fields you send are changed. Requires the leads:write scope.

The lead's client and contact are not editable here - they are separate resources with their own lifecycle. To move the lead between pipeline stages, use PATCH /api/v1/leads/{lead}/stage.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

lead

uuid

required

Lead ID

Body Params

The lead's own details. Every field is optional and only the fields you send are changed - omit a field to leave it as it is, or send it as null to clear it (except source, which can only be changed, never cleared). The lead's client and contact are not editable here.

title

string | null

A descriptive title for this lead

temperature

enum

How likely this lead is to convert, or null to clear it

Lead temperature indicating urgency or priority level

source

string

Where this lead came from. Cannot be cleared - sending null is a validation error.

source_note

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. A note already on the lead satisfies that requirement.

deal_size

enum

Expected size category of this deal, or null to clear it

Deal size classification

owner_id

uuid | null

A team member in the same practice as the lead. Send null to leave the lead unowned.

Responses

200Lead updated successfully

401Unauthorized

403Forbidden

404Not Found

422Validation Error