Update Lead

Updates an existing lead.

PUT/api/v1/leads/{lead_id}

Examples

Request

curl --request PUT \
  --url 'https://api.vaanii.ai/api/v1/leads/007bd847-98fa-4db2-bfe3-f8de494cfa68' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <your_api_key>' \
  --data '{"first_name":"Priya","custom_fields":{"loan_amount":935961}}'

Response

Possible HTTP status codes for this endpoint, with a representative response body for each. Select a status to preview it.

200 OKSuccessful response

{
  "id": "da27314b-6cc4-4aa2-a996-bbcd160b0c3d",
  "campaign_id": "0bacf086-0b7f-4115-aa01-3e8b3b6a9ffc",
  "first_name": "Priya",
  "phone_e164": "+919897585976",
  "status": "new",
  "custom_fields": {
    "loan_amount": 935961
  },
  "calls_count": 0,
  "updated_at": "2026-09-11T23:38:44+05:30",
  "next_scheduled_call": "2026-09-12T04:39:44+05:30"
}

Description

Updates one or more lead fields. The phone number, when changed, is checked for duplicates within the campaign.

Parameters

Path param	Type	Description
`lead_id`	UUID	The lead's ID.

Request body (JSON) — all fields optional

All fields optional. Accepts any subset.

Field	Type	Description
`first_name` `PUT`	string	New first name.
`phone_e164` `PUT`	string	New phone number (checked for duplicates).
`custom_fields` `PUT`	object	Replace the custom variables.

status is not supported as an update field. Status is system-managed and is changed through the Stop Lead endpoint where applicable.

Response — 200 OK

The updated Lead Object.

Errors

Status	Detail
`400`	Invalid phone number.
`400`	Invalid `first_name` after preprocessing.
`404`	Lead not found or not in your company.
`409`	Phone already used by another lead.