Skip to main content
POST
Removes many target accounts in one call. Select them in one of two ways, never both:
  • target_account_ids: the ids from List Target Accounts.
  • filters: the list’s own filters (search, tier, source, matched), as an object or as the query string the list takes, like "search=acme&tier=__none__". An unknown filter answers 400.
One call selects at most 1,000 target accounts (the queries.target_accounts.bulk_max_selection setting). A larger selection answers 400 and removes nothing: narrow the filters and try again. An empty selection answers 200 with zeros. It removes only the entries you put there. Rows a bound CRM list puts on the target list are skipped, never an error: crm_rows_remaining counts them. To act on those, change the list in your CRM, or exclude the company. matched is how many selected rows were on your list, removed how many were deleted. A filter selection reads the list as it was a few seconds ago: a row added just before may be missed. Ids select exactly.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json
target_account_ids
string<uuid>[]

The target accounts to remove, by id.

filters

The target list's filters, in place of target_account_ids: an object, e.g. {"source": ["csv"], "matched": false}. The query string itself, as a JSON string, is accepted too.

Response

How many target accounts were selected, removed and left.

success
boolean
required
data
object
required