Lists

Create Empty List

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.

post/lists/create-empty

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/lists/create-empty
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

titlestring required
source'csv' | 'graph8' | 'FormSubmission' | 'visitor' | 'salesforce' | 'hubspot' | 'keyword' | 'intent' | 'workbench' required

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

type'contacts' | 'companies' | 'suppressions' | 'deals' | 'leads'

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.

status'completed' | 'processing' | 'failed'
is_dynamicboolean

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

descriptionstring nullable
idempotency_keystring nullable

Retry-safe: the same key returns the same list.

request_fingerprintstring nullable

Response

Successful Response

dataListPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.