Hold an artwork
Holds the artwork for one party (`party_id`) until a release date (`ends_on`, today or later), with an optional member note. The work reads as on hold until the hold is released or its release date passes; the database derives it in the same request. A work carries one active hold: a second answers 409 with the holder and the release date, as far as the caller may read them. A hold that already lapsed is released as expired first. Needs `contacts:read` to resolve the party.
Holds the artwork for one party (party_id) until a release date (ends_on, today or later), with an optional member note. The work reads as on hold until the hold is released or its release date passes; the database derives it in the same request. A work carries one active hold: a second answers 409 with the holder and the release date, as far as the caller may read them. A hold that already lapsed is released as expired first. Needs contacts:read to resolve the party.
Authorization
bearerAuth artworks:update, contacts:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:update, contacts:read
Path Parameters
The artwork id.
Query Parameters
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
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.
Hold an artwork for one party until a release date.
Response Body
application/json
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "dry_run": true, "effect": { "summary": "string", "count": 0, "targets": [ { "type": "string", "id": "string", "label": "string" } ], "amount": { "minor": -9007199254740991, "currency": "str" }, "details": { "property1": "string", "property2": "string" }, "irreversible": true }}{ "id": "string", "artwork_id": "string", "party_id": "string", "ends_on": "string", "released_at": "string", "released_reason": "string", "note": "string", "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Take an artwork live POST
Makes the artwork's newest saved version the live, publicly readable state. Pending unsaved edits are left alone. Fails if the artwork has never been saved.
Register an artwork image POST
Registers an already-uploaded object (from the upload-url endpoint) as an image row, appended to the end. Requires a first-party session.