Consign an artwork out
Records an outbound consignment on the artwork: the consignee (`counterparty_contact_id`), such as another gallery or an auction house, the shares in basis points, an optional flat net price, the term's dates and, optionally, the day the agreement was signed (`signed_on`). An outbound consignment changes no derived state. Needs `contacts:read` to resolve the consignee.
Records an outbound consignment on the artwork: the consignee (counterparty_contact_id), such as another gallery or an auction house, the shares in basis points, an optional flat net price, the term's dates and, optionally, the day the agreement was signed (signed_on). An outbound consignment changes no derived state. Needs contacts:read to resolve the consignee.
Authorization
bearerAuth artworks:create, contacts:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:create, 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.
Consign an artwork out: the consignee, the shares and the term.
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", "direction": "string", "counterparty_contact_id": "string", "consignor_share_bps": -9007199254740991, "consignee_share_bps": -9007199254740991, "third_party_share_bps": -9007199254740991, "net_price_cents": -9007199254740991, "start_date": "string", "end_date": "string", "notes": "string", "signed_on": "string", "ended_on": "string", "ended_reason": "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}Consign an artwork in POST
Records an inbound consignment on the artwork: the consignor (`counterparty_contact_id`), the day the agreement was signed (`signed_on`, required), the shares in basis points, an optional flat net price, and the term's dates. `start_date` is the day the work arrives. The work reads as consigned in from `signed_on`, within the term; the database derives it in the same transaction. Needs `contacts:read` to resolve the consignor.
Create an artwork POST
Creates an artwork in the gallery.