Gallery Platform API
ReferenceGalleryArtworksId

Update an artwork

Edits accumulate in the artwork's draft; the published state the site serves is unchanged until you publish.

PATCH
/gallery/artworks/{id}

Edits accumulate in the artwork's draft; the published state the site serves is unchanged until you publish.

Authorization

bearerAuth artworks:write
AuthorizationBearer <token>

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

In: header

Scope: artworks:write

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 24h instead of re-running the write.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields to update on an artwork (all optional).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/gallery/artworks/{id}" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "title": "string",  "artist_id": "552fe3fb-5e61-4c8e-abbd-a992d77f7900",  "inventory_number": "string",  "ownership_status": "owned",  "availability_state": "available",  "status": "available",  "medium": "string",  "year": -9007199254740991,  "description": "string",  "dimension_unit": "in",  "height_cm": 0,  "width_cm": 0,  "depth_cm": 0,  "framed_height_cm": 0,  "framed_width_cm": 0,  "framed_depth_cm": 0,  "dimensions_text": "string",  "location": "string",  "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",  "price_cents": -9007199254740991,  "currency": "string",  "is_edition": true,  "edition_number": -9007199254740991,  "edition_size": -9007199254740991,  "edition_type": "numbered",  "edition_overrides": [    "string"  ],  "parent_artwork_id": "ddf911f4-6b3b-4d9d-8a95-211e9ed22b01",  "coa_status": "not_required",  "coa_tracking_number": "string",  "condition_status": "excellent",  "condition_notes": "string",  "show_price_publicly": true,  "published_at": "string",  "published_version": -9007199254740991,  "source_system": "string",  "source_external_id": "string",  "formats": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "artwork_id": "1a900bf9-a284-4c99-a359-1f6b482d475f",      "label": "string",      "height_cm": 0,      "width_cm": 0,      "depth_cm": 0,      "dimension_unit": "in",      "medium": "string",      "edition_size": -9007199254740991,      "stock_quantity": -9007199254740991,      "availability_state": "available",      "price_cents": -9007199254740991,      "currency": "string",      "position": -9007199254740991,      "created_at": "string",      "updated_at": "string"    }  ],  "created_at": "string",  "updated_at": "string"}