Update a publication
Patches a publication's fields (bibliographic, stock, availability, visibility, price). Only supplied fields change; `published` toggles its published_at. For a member, the bibliographic edits accumulate in the working draft until the next save; for an API key or an installed app, they land on the record. Pass `draft` to choose; `applied_to` in the response says where the write went.
Patches a publication's fields (bibliographic, stock, availability, visibility, price). Only supplied fields change; published toggles its published_at. For a member, the bibliographic edits accumulate in the working draft until the next save; for an API key or an installed app, they land on the record. Pass draft to choose; applied_to in the response says where the write went.
Authorization
bearerAuth publications:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: publications:update
Path Parameters
The publication id.
Query Parameters
Where the write lands. true: the working draft (a member's default). false: the record itself, reconciling any pending draft (a key's default). Omit for the principal's default.
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.
Patch a publication (only supplied fields change).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "title": "string", "subtitle": "string", "publisher": "string", "isbn": "string", "editor": "string", "author": "string", "page_count": -9007199254740991, "publication_year": -9007199254740991, "dimensions_text": "string", "inventory_number": "string", "description": "string", "stock_quantity": -9007199254740991, "availability_state": "available", "cover_image_path": "string", "published_at": "string", "visibility": "public", "show_price_publicly": true, "price_cents": -9007199254740991, "currency": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string", "save_state": "new", "applied_to": "draft"}{ "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}