Patch Lead - Nexor

curl --request PATCH \ --url https://api.getnexor.ai/api/public/leads/{id} \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "metadata": { "contacted_externally": true } } '

{ "success": true, "lead": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "first_name": "<string>", "source": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "last_name": "<string>", "email": "jsmith@example.com", "phone": "<string>", "company": "<string>", "title": "<string>", "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } }

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

string<uuid>

required

Lead ID

Body

application/json

Any lead field can be updated. Metadata is shallow-merged with existing values (other keys preserved). All other fields are replaced directly.

first_name

string

Lead's first name

Example:

"Carlos"

last_name

string | null

Lead's last name

Example:

"Rodriguez"

string<email> | null

Lead's email address

Example:

"carlos@example.com"

phone

string | null

Lead's phone number

Example:

"+56987654321"

company

string | null

Lead's company name

Example:

"Stark Industries"

title

string | null

Lead's job title

Example:

"Manager"

source

string

Lead source

Example:

"website"

campaign_id

string<uuid> | null

Campaign ID to tag the lead with. Set to null to remove campaign assignment.

Example:

"123e4567-e89b-12d3-a456-426614174001"

metadata

object

Key-value pairs to merge into the lead's existing metadata. Existing keys not included in this object are preserved. New keys are added. Matching keys are overwritten with the new value.

Example:

{
  "estado_lead": "calificado",
  "broker_asociado": "Maria Gonzalez"
}

Response

Lead updated successfully

success

boolean

required

Example:

true

lead

object

required

Show child attributes