Gallery Platform API
Reference

Create a contact list

Creates a pipeline, segment, or mailing list.

POST
/gallery/contact-lists

Creates a pipeline, segment, or mailing list.

Authorization

bearerAuth contacts:create
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: contacts:create

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a contact list.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "title": "string",  "description": "string",  "kind": "pipeline",  "is_dynamic": true,  "dynamic_query": {    "q": "string",    "type": "collector",    "assigned_to": null,    "lead_status": "new",    "tag_id": null,    "has_interaction_since": "2019-08-24T14:15:22Z",    "min_total_spend_cents": 0,    "min_works_acquired": 0,    "price_band": "under_5k"  },  "created_at": "string",  "updated_at": "string"}

Amend consignment terms PATCH

Amends a consignment's splits, counterparty, dates, or notes. Direction is fixed at creation and cannot change (it drives which side a sale's payable pays).

Delete a contact list DELETE

Permanently deletes a contact list (its stages and entries are removed; the contacts are untouched).