Skip to content

Delete Companies From List

DELETE
/lists/{audience_id}/companies

Remove companies from a list.

Authorizations

Parameters

Path Parameters

audience_id
required

List (audience) id.

integer

List (audience) id.

Query Parameters

agFilterModel
Any of:
string

AgGrid filter JSON. Every company in the list matching it is removed, IN ADDITION to company_ids - the two combine rather than the filter narrowing the ids.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
company_ids
Array<integer>

Responses

200

Successful Response

object
data
required

An open envelope for a list, a capability map or a job result.

Open because several of these return the whole Audience, whose shape carries per-source metadata that differs between an uploaded file, a dynamic query and a master list - and grows with them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string