Skip to main content
DELETE
/
api
/
v2
/
voice-campaigns
/
{campaign_id}
/
leads
/
remove
/
bulk
Bulk Remove Leads from Campaign
curl --request DELETE \
  --url https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/remove/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "phone_number": "+14155552671"
  },
  {
    "campaign_lead_id": "VoiceCampaignLead:42"
  }
]
'
{
  "status": "success",
  "message": "Bulk lead removal completed",
  "results": [
    {
      "index": 0,
      "phone_number": "+14155552671",
      "success": true,
      "message": "Lead removed successfully"
    },
    {
      "index": 1,
      "campaign_lead_id": "VoiceCampaignLead:42",
      "success": false,
      "message": "Lead not found with the given phone number or campaign lead id"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

Identifier of the campaign. Required.

Example:

"camp_abc123"

Body

application/json

Array of lead identifiers to remove. Each object must include phone_number or campaign_lead_id.

Minimum array length: 1
​
phone_number
string

Lead phone number in E.164 format. Required if campaign_lead_id is not provided.

Example:

"+14155552671"

​
campaign_lead_id
string

Global ID of the campaign lead record. Required if phone_number is not provided.

Example:

"Vm9pY2VDYW1wYWlnbkxlYWQ6MTIzNA=="

Example:
[
  { "phone_number": "+14155552671" },
  {
    "campaign_lead_id": "VoiceCampaignLead:42"
  }
]

Response

Bulk removal completed. Per-lead results are included in results.

​
status
string
​
message
string
​
results
object[]