Skip to content

Create Master List

POST
/lists/masters

Create a master list from other lists.

include_all_sources takes EVERY list of this type, including ones created later - a standing rule rather than a snapshot, and it makes source_list_ids irrelevant.

The first sync runs in the BACKGROUND, so the list comes back empty and fills shortly after.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A list that is the UNION of other lists, kept in sync.

object
include_all_sources

Take EVERY list of this type instead of the named ones, including ones created later. source_list_ids is then ignored.

boolean
source_list_ids

The lists to union.

Array<integer>
title
required
string
<= 500 characters
type

Wire name is type; see CreateEmptyListRequest.

string
default: contacts
Allowed values: contacts companies suppressions deals leads

Responses

201

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