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] } }
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Campaign to unassign the matched leads from.

where
object
required

Filter conditions selecting the leads to unassign. Any lead field may be used; a value may be a scalar (equals) or an array (IN).

Responses
204

Leads unassigned. No content.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json