Campaign-Leads

Mass unassign leads

Remove many leads from a campaign in a single request.

When to use. Take a set of leads off a campaign without deleting the leads themselves. This is the reverse of PUT /campaign-leads/mass-assign.

Parameters.

  • campaign_id (integer, required): the campaign to unassign the matched leads from.
  • where (object, required): conditions selecting the leads to unassign, typically by their id values. Each value may be a single value (exact match) or an array (matches any of the listed values).

Returns. 204 No Content on success.

Example.

{ "campaign_id": 12, "where": { "id": [1, 2, 3] } }
put/{sub_domain}/api/campaign-leads/mass-unassign

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

campaign_idinteger required

Campaign to unassign the matched leads from.

Response

Successful Response

Changes

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