Patch a preset by layer id

Partial edit: layer_patches are merged by layer id, everything else is left alone. Saves a new version and does NOT consume a template slot. Unknown fields are rejected with did-you-mean hints. preview: true returns the rendered image in the same response.

patch/presets/{id}

Request

  • Base URL: https://rendry.io/api/v1
  • URL: https://rendry.io/api/v1/presets/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Headers

X-Rendry-Accountstring

Browser/OAuth current member account selector. API keys/embed credentials are bound to their persisted account and reject another account. Omitting this header selects the browser actor personal account.

Request body

namestring
layersobject[]

Full replacement of the layer tree

layer_patchesobject[]

Partial patches merged by layer id

previewboolean

Also return the rendered preview inline, charged the preview price (0.1 credit) like POST /render/preview; the file is capped at 640 px on the long side. Saving the new version itself costs nothing.

Response

New version saved

preset_idstring

The template's group id

preset_group_idstring

The template's group id, equal to preset_id

version_idstring

The exact version row written by this patch

parent_idstring

The exact predecessor version read before applying this patch

namestring
variablesstring[]

Every {variable} the patched layers accept in dynamic_data

hintstring
warningsstring[]

Findings about the FINAL state after the patch; empty when the layout checks found nothing

warnings_notestring

What the warnings list covers

chart_fitobject[]

Measured geometry of every chart layer; sent only when the preset has one

palettesobject

The data palettes in force, when the preset declares any

autofixed_fieldsstring[]

Fields renamed on the way in

autofix_notestring
image_base64string

With preview: true — the updated design as a JPEG

mime_typestring
look_at_itstring

With preview: true — what to check on the picture

preview_notestring

With preview: true — why no picture came back

Changes

No recorded changes to this operation across all 1 revision of this API.