Replace a preset's authored prose
Replaces the preset's prose for one document kind and locale. Whole-set: a slot you send is a value (an empty string renders a deliberate blank), and a slot you omit is deleted and inherits again. Requires the gallery:write scope (key) or editor membership (user).
Replaces the preset's prose for one document kind and locale. Whole-set: a slot you send is a value (an empty string renders a deliberate blank), and a slot you omit is deleted and inherits again. Requires the gallery:write scope (key) or editor membership (user).
Authorization
bearerAuth gallery:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: gallery:update
Path Parameters
The document preset id.
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.
Replaces a preset's prose for one document kind and locale. Whole-set: omitting a slot removes it.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "data": [ { "slot_id": "string", "locale": "string", "body": "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}List the gallery's document presets GET
Returns the gallery's named presentation presets, the default first. Filtering by document_kind also returns the presets that apply to every kind, since those dress that document too.
Update a document preset PATCH
Patches a named document presentation preset. Only supplied fields change; setting a field to null makes it inherit the gallery's branding again. Requires the gallery:write scope (key) or editor membership (user).