Amend consignment terms
Amends a consignment's splits, counterparty, dates, or notes. Direction is fixed at creation and cannot change (it drives which side a sale's payable pays).
Amends a consignment's splits, counterparty, dates, or notes. Direction is fixed at creation and cannot change (it drives which side a sale's payable pays).
Authorization
bearerAuth artworks:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:update
Path Parameters
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.
Amend consignment terms (splits, counterparty, dates, notes). Direction is immutable.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "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", "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}List consignments GET
Lists the gallery's consignment terms across all artworks, newest first, with cursor pagination. Filter by `direction` (in/out), `counterparty_contact_id`, or `expiring_before` (an `end_date` on or before a date — the 'lapsing soon' view).
Create a contact list POST
Creates a pipeline, segment, or mailing list.