Bulk remove campaign contacts

Bulk remove contacts from a campaign using the same filter criteria as bulk add.

Contacts that already have a call record, or that are sitting in an active queue slot, are never removed — the response reports matched and removed separately so a partial removal is visible rather than silent.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

campaignIdstringRequiredformat: "uuid"
Campaign ID

Request

This endpoint expects an object.
filterobjectRequired
Filter criteria to select which contacts to remove

Response

Contacts removed via filter criteria
matchedlong
Number of campaign contacts matching the filter
removedlong
Number actually removed
skippedlong
Number left in place because they were already called or in the queue

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error