Leads

Delete Leads

Delete multiple leads that match a filter.

When to use. Remove many leads in one request. To delete a single known lead, use DELETE /leads/{id}.

Request body. A filter object selecting which leads to delete. Each key is a lead field: a scalar value matches by equality and an array matches any of the listed values. An empty body is rejected with 400.

Returns. { "removedLeads": [ ... ] } listing the leads that were deleted.

Example. PUT /api/leads/mass-delete with body { "id": [ 101, 102 ] }

put/{sub_domain}/api/leads/mass-delete

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

first_namestring[] nullable

Match by first name(s).

Response

Successful Response

removedLeadsobject[] required

Changes

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