Skip to main content

Patch Lead

PATCH /leads/{id}

Partial update of a lead. Identical behavior to PUT — any field can be updated, and metadata is shallow-merged (existing keys preserved, new keys added, matching keys overwritten).

Path Parameters

ParameterTypeRequiredDescription
idstring (uuid)YesLead ID

Request Body

Same fields as Update Lead. All fields are optional.

Examples

Set a metadata flag

curl -X PATCH https://api.getnexor.ai/api/public/leads/123e4567-e89b-12d3-a456-426614174000 \
-H "Content-Type: application/json" \
-H "X-API-Key: nxr_live_your_api_key" \
-d '{
"metadata": {
"contacted_externally": true
}
}'

Update just the email

curl -X PATCH https://api.getnexor.ai/api/public/leads/123e4567-e89b-12d3-a456-426614174000 \
-H "Content-Type: application/json" \
-H "X-API-Key: nxr_live_your_api_key" \
-d '{
"email": "newemail@example.com"
}'

Responses

200 — Lead updated successfully

Returns the updated lead object (same schema as Update Lead).

400 — Validation error

401 — Authentication error

See Authentication.

404 — Lead not found

500 — Internal server error