Gallery Platform API
Reference

Update an artwork on a show

Edits one artwork's entry on the show's checklist: its position, catalogue number, status, lender, note, or for an art fair its booth, wall and priority. Only the fields sent change. A booth must belong to this show, and a lender to this gallery.

PATCH
/gallery/shows/{showId}/artworks/{artworkId}

Edits one artwork's entry on the show's checklist: its position, catalogue number, status, lender, note, or for an art fair its booth, wall and priority. Only the fields sent change. A booth must belong to this show, and a lender to this gallery.

Authorization

bearerAuth shows:update
AuthorizationBearer <token>

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

In: header

Scope: shows:update

Path Parameters

showId*string

The show id.

artworkId*string

The artwork id.

Query Parameters

dry_run?boolean

Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.

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.

The fields of the work's entry on the show to change; the rest stay as they are.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "show_id": "string",  "artwork_id": "string",  "artwork_title": "string",  "position": -9007199254740991,  "catalogue_number": "string",  "checklist_status": "proposed",  "lender_party_id": "string",  "note": "string",  "booth_id": "string",  "wall": "string",  "priority": -9007199254740991,  "valid_from": "string"}