Campaign-Leads

Mass delete campaign leads

Delete many campaign leads at once by their IDs.

When to use. Remove campaign-lead assignments in bulk when you already know their campaign-lead IDs. To remove leads from a campaign by a filter instead, use PUT /campaign-leads/mass-unassign.

Parameters.

  • id (array of integers, required): the campaign-lead IDs to delete.

Returns. { "removedLeads": [ ... ] }, the campaign-lead records that were removed.

Example.

{ "id": [1, 2] }
put/{sub_domain}/api/campaign-leads/mass-delete

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/campaign-leads/mass-delete
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

Response

Successful Response

removedLeadsobject[] required

Changes

No recorded changes to this operation across all 1 revision of this API.