Agents Platform

Remove An Outbound Campaign Lead

Changed on

Remove a lead from an outbound campaign so it is never called again. Returns 202 when a call already placed may still go through.

delete/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}

Request

Path parameters

campaign_idstring required
lead_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

campaign_idstring required
lead_idstring required
has_calls_in_flightboolean required

Whether a call already handed off for dialing may still go through.

Changes