Update an artwork format
Patches a format's editable fields (label, dimensions, medium, edition size, stock, availability, price). Only supplied fields change.
Patches a format's editable fields (label, dimensions, medium, edition size, stock, availability, price). Only supplied fields change.
Authorization
bearerAuth artworks:writeA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:write
Header Parameters
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.
Update a format/variant's editable fields (PATCH).
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}/formats/{formatId}" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "details": null}