Stop Lead

Stops the campaign from calling a lead.

POST/api/v1/leads/{lead_id}/stop

Examples

Request

curl --request POST \
  --url 'https://api.vaanii.ai/api/v1/leads/f5a94d21-da35-4eaa-b2ba-cfe200b6d5a6/stop' \
  --header 'X-API-Key: <your_api_key>'

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": "17d2572c-78bc-41a4-b543-0bb86cbe4d10",
  "campaign_id": "7afca01b-a324-4b18-aef1-b23ccb9f19d8",
  "first_name": "Sneha",
  "phone_e164": "+919513659325",
  "status": "stopped",
  "custom_fields": {
    "loan_amount": 821151,
    "city": "Mumbai"
  },
  "calls_count": 0,
  "updated_at": "2026-09-11T23:38:43+05:30",
  "next_scheduled_call": "2026-09-11T23:58:43+05:30"
}

Description

Sets the lead's status to stopped. The scheduler only picks up leads whose status is new or rescheduled, so a stopped lead will not be dialed again.

Parameters

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

Response — 200 OK

The updated Lead Object with status: "stopped".

Errors

Status	Detail
`404`	Lead not found or not in your company.