Skip to content

Refresh Dynamic List

POST
/lists/{audience_id}/refresh

Re-run a dynamic list’s query now.

Membership can go DOWN as well as up: a record that no longer matches leaves. Only meaningful for a list created with is_dynamic.

Authorizations

Parameters

Path Parameters

audience_id
required

List (audience) id.

integer

List (audience) id.

Header Parameters

X-Target-Org-Id
Any of:
string

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