Stop Lead

Stops the campaign from calling a lead.

Base URL: examples use <vaanii_api_base_url> in place of the Vaanii API address. Contact the Vaanii team at team@vaanii.ai to get it.

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

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 paramTypeDescription
lead_idUUIDThe lead's ID.

Response — 200 OK

The updated Lead Object with status: "stopped".

Errors

StatusDetail
404Lead not found or not in your company.