Skip to content

Create Empty List

POST
/lists/create-empty

Create a list with nothing in it, to fill later.

SEND AN idempotency_key. Without one a retried request makes a second empty list, and a duplicate list is harder to notice than a failed call.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a list with nothing in it, to fill later.

idempotency_key is worth using: without one, a retried create makes a SECOND empty list, and a duplicate list is harder to notice than a failed request.

object
description
Any of:
string
idempotency_key
Any of:
string
is_dynamic

A dynamic list re-runs its query; a static one keeps what it is given.

boolean
request_fingerprint
Any of:
string
source
required

Where the list comes from, e.g. csv.

string
Allowed values: csv graph8 FormSubmission visitor salesforce hubspot keyword intent workbench
status
string
default: completed
Allowed values: completed processing failed
title
required
string
>= 1 characters <= 200 characters
type

What the list holds. The wire name is type; the app’s field is type_ because type is a Python builtin, and the alias keeps the wire name identical to the app’s.

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