Gallery Platform API
Reference

Update a list's catalogue content

Upserts the list's catalogue-PDF content. Only supplied fields change; null clears a field. Editor-only (enforced by RLS).

PATCH
/gallery/lists/{listId}/catalogue

Upserts the list's catalogue-PDF content. Only supplied fields change; null clears a field. Editor-only (enforced by RLS).

Authorization

bearerAuth artworks:update
AuthorizationBearer <token>

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

In: header

Scope: artworks:update

Path Parameters

listId*string

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.

Upsert a list's catalogue content. Only supplied fields change; null clears a field.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "subtitle": "string",  "starts_on": "string",  "ends_on": "string",  "venue": "string",  "cover_image_path": "string",  "foreword": "string",  "colophon": "string",  "updated_at": "string"}