Brand operations

13 operations named brand.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.

Updated10/26/2026

Operation	What it does	Permission	Confirmation
brand.setup	Set the site's brand from three colours, a type pairing, a type ratio and base size, a spacing unit and a corner style: the server derives every token write of the brand (the brand, accent and neutral palette ramps, the light and dark colour roles as aliases of palette steps, the font sizes and families, the main type presets, the space steps and the radii) and lands them as one designSystem.setTokens change, gated once for AA contrast on the end state, so one undo restores the lot.	designSystem.operation	none
brand.presets	brand.presets with brand validation and transactional history.	site.admin	none
brand.templates	brand.templates with brand validation and transactional history.	site.admin	none
brand.updateIdentity	brand.updateIdentity with brand validation and transactional history.	site.admin	none
brand.createPreset	brand.createPreset with brand validation and transactional history.	site.admin	none
brand.renamePreset	brand.renamePreset with brand validation and transactional history.	site.admin	none
brand.deletePreset	brand.deletePreset with brand validation and transactional history.	site.admin	destructive
brand.createTemplate	brand.createTemplate with brand validation and transactional history.	site.admin	none
brand.updateTemplate	brand.updateTemplate with brand validation and transactional history.	site.admin	none
brand.deleteTemplate	brand.deleteTemplate with brand validation and transactional history.	site.admin	destructive
brand.rebuildTemplate	brand.rebuildTemplate with brand validation and transactional history.	site.admin	none
brand.render	brand.render from an approved, curated template through a standalone render boundary.	brand.generate	none
brand.save	brand.save from an approved, curated template through a standalone render boundary.	brand.generate	none

brand.setup

Set the site's brand from three colours, a type pairing, a type ratio and base size, a spacing unit and a corner style: the server derives every token write of the brand (the brand, accent and neutral palette ramps, the light and dark colour roles as aliases of palette steps, the font sizes and families, the main type presets, the space steps and the radii) and lands them as one designSystem.setTokens change, gated once for AA contrast on the end state, so one undo restores the lot. A brand with pairs below AA is refused unless the input carries acknowledgeContrast: true, the designer's explicit "save anyway", which the stored batch keeps; then the failing pairs come back as error findings. The admin's Brand setup screen runs this same operation.

permission: designSystem.operationwrites: designSystemclass: transactionundo: yes

Example input

{
  "primary": "#1e3d4f",
  "secondary": "#c8553d",
  "neutral": "#737373",
  "headingFamily": [
    "DM Sans",
    "sans-serif"
  ],
  "bodyFamily": [
    "DM Sans",
    "sans-serif"
  ],
  "typeRatio": 1.25,
  "baseSize": 17,
  "spaceBase": 4,
  "radius": "soft"
}

Input

Field	Type	Required	Notes
primary	string	yes
secondary	string	yes
neutral	string	yes
headingFamily	array of string	yes	At least 1 item.
bodyFamily	array of string	yes	At least 1 item.
typeRatio	number	yes	One of 1.125, 1.2, 1.25, 1.333.
baseSize	integer	yes	At least 14. At most 22.
spaceBase	number	yes	One of 4, 8.
radius	string	yes	One of "sharp", "soft", "round", "pill".
acknowledgeContrast	true	no

Output

Field	Type	Required	Notes
tree	object	no
tree.pageId	string	yes
tree.revision	integer	yes
tree.inverse	array of object \| object \| object \| object \| object \| object \| object \| object \| object \| object \| object \| object \| object	yes
findings	array of object \| object \| object \| object \| object	yes
diff	array of object \| object \| object \| object \| object \| object	yes
changes	array of object	no
changes[].change	string	yes	One of "added", "changed", "removed".
changes[].override	object \| object \| object \| object \| object \| object	yes
changed	boolean	yes
revision	integer	yes
dryRun	boolean	yes
css	string \| null	yes
report	object	no
report.adds	array of object	yes
report.changes	array of object	yes
report.typeConflicts	array of object	yes
report.unknownNames	array of object	yes

Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.

Try it

yarn splash brand.setup '{"primary":"#1e3d4f","secondary":"#c8553d","neutral":"#737373","headingFamily":["DM Sans","sans-serif"],"bodyFamily":["DM Sans","sans-serif"],"typeRatio":1.25,"baseSize":17,"spaceBase":4,"radius":"soft"}' --dry-run

brand.presets

brand.presets with brand validation and transactional history.

permission: site.adminreads onlyclass: read

Example input

{}

Input

The input is a record; see the schema below.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output

Field	Type	Required
presets	array of object	yes
presets[].presetId	string	yes
presets[].presetName	string	yes
presets[].updatedAt	string	yes

Try it

yarn splash brand.presets '{}' --dry-run

brand.templates

brand.templates with brand validation and transactional history.

permission: site.adminreads onlyclass: read

Example input

{}

Input

The input is a record; see the schema below.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output

Field	Type	Required	Notes
templates	array of object	yes
templates[].id	string	yes	At least 1 character.
templates[].name	string	yes
templates[].pageId	string	yes	At least 1 character.
templates[].snapshot	object \| null	yes	Default null.
templates[].customerSettings	record of array of string \| null	yes	Default null.
templates[].status	string	yes	One of "draft", "approved".
templates[].version	number	yes
templates[].width	number	yes
templates[].height	number	yes
templates[].createdAt	string	yes
templates[].updatedAt	string	yes

Try it

yarn splash brand.templates '{}' --dry-run

brand.updateIdentity

brand.updateIdentity with brand validation and transactional history.

permission: site.adminwrites: brandclass: transactionundo: yes

Example input

{
  "identity": {
    "brandName": "Studio",
    "tagline": "Architecture and landscape"
  }
}

Input

Field	Type	Required	Notes
presetId	string	no	At least 1 character.
identity	object	yes
identity.brandName	string	no
identity.tagline	string	no
identity.logoPrimary	string \| null	no
identity.logoInverse	string \| null	no
identity.logoMark	string \| null	no
identity.brandPrimary	string	no
identity.brandSecondary	string	no
identity.brandSurface	string	no
identity.brandOnSurface	string	no
identity.headlineRole	string	no
identity.bodyRole	string	no
identity.toneWords	string	no
identity.doRules	string	no
identity.dontRules	string	no

Output

Field	Type	Required
identity	object	yes
identity.brandName	string	yes
identity.tagline	string	yes
identity.logoPrimary	string \| null	yes
identity.logoInverse	string \| null	yes
identity.logoMark	string \| null	yes
identity.brandPrimary	string	yes
identity.brandSecondary	string	yes
identity.brandSurface	string	yes
identity.brandOnSurface	string	yes
identity.headlineRole	string	yes
identity.bodyRole	string	yes
identity.toneWords	string	yes
identity.doRules	string	yes
identity.dontRules	string	yes

Try it

yarn splash brand.updateIdentity '{"identity":{"brandName":"Studio","tagline":"Architecture and landscape"}}' --dry-run

brand.createPreset

brand.createPreset with brand validation and transactional history.

permission: site.adminwrites: brandclass: transactionundo: yes

Example input

{
  "presetName": "Autumn campaign"
}

Input

Field	Type	Required	Notes
presetName	string	yes	At least 1 character. At most 120 characters.
cloneFrom	string	no	At least 1 character.

Output

Field	Type	Required
presetId	string	yes
presetName	string	yes
updatedAt	string	yes

Try it

yarn splash brand.createPreset '{"presetName":"Autumn campaign"}' --dry-run

brand.renamePreset

brand.renamePreset with brand validation and transactional history.

permission: site.adminwrites: brandclass: transactionundo: yes

Example input

{
  "presetId": "autumn-campaign",
  "presetName": "Autumn campaign 2026"
}

Input

Field	Type	Required	Notes
presetId	string	yes	At least 1 character.
presetName	string	yes	At least 1 character. At most 120 characters.

Output

Field	Type	Required
presetId	string	yes
presetName	string	yes
updatedAt	string	yes

Try it

yarn splash brand.renamePreset '{"presetId":"autumn-campaign","presetName":"Autumn campaign 2026"}' --dry-run

brand.deletePreset

brand.deletePreset with brand validation and transactional history.

permission: site.adminwrites: brandclass: transactionconfirm: destructiveundo: yes

Example input

{
  "presetId": "autumn-campaign"
}

Input

Field	Type	Required	Notes
presetId	string	yes	At least 1 character.

Output

Field	Type	Required	Notes
status	"deleted"	yes

Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.

brand.createTemplate

brand.createTemplate with brand validation and transactional history.

permission: site.adminwrites: brand, pagesclass: transactionundo: yes

Example input

{
  "name": "Instagram post",
  "width": 1080,
  "height": 1080
}

Input

Field	Type	Required	Notes
name	string	yes	At least 1 character. At most 120 characters.
width	integer	yes	At least 16. At most 4096.
height	integer	yes	At least 16. At most 4096.
layoutId	string	no	At least 1 character.

Output

Field	Type	Required	Notes
id	string	yes	At least 1 character.
name	string	yes
pageId	string	yes	At least 1 character.
snapshot	object \| null	yes	Default null.
customerSettings	record of array of string \| null	yes	Default null.
status	string	yes	One of "draft", "approved".
version	number	yes
width	number	yes
height	number	yes
createdAt	string	yes
updatedAt	string	yes

Try it

yarn splash brand.createTemplate '{"name":"Instagram post","width":1080,"height":1080}' --dry-run

brand.updateTemplate

brand.updateTemplate with brand validation and transactional history.

permission: site.adminwrites: brand, pagesclass: transactionundo: yes

Example input

{
  "templateId": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "patch": {
    "name": "Instagram post, square"
  }
}

Input

Field	Type	Required	Notes
templateId	string	yes	At least 1 character.
patch	object	yes
patch.name	string	no	At most 120 characters.
patch.status	string	no	One of "draft", "approved".
patch.customerSettings	record of array of string \| null	no
patch.expectedDraftRevision	string	no

Output

Field	Type	Required	Notes
id	string	yes	At least 1 character.
name	string	yes
pageId	string	yes	At least 1 character.
snapshot	object \| null	yes	Default null.
customerSettings	record of array of string \| null	yes	Default null.
status	string	yes	One of "draft", "approved".
version	number	yes
width	number	yes
height	number	yes
createdAt	string	yes
updatedAt	string	yes

Try it

yarn splash brand.updateTemplate '{"templateId":"4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b","patch":{"name":"Instagram post, square"}}' --dry-run

brand.deleteTemplate

brand.deleteTemplate with brand validation and transactional history.

permission: site.adminwrites: brand, pagesclass: transactionconfirm: destructiveundo: yes

Example input

{
  "templateId": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b"
}

Input

Field	Type	Required	Notes
templateId	string	yes	At least 1 character.

Output

Field	Type	Required	Notes
success	true	yes

Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.

brand.rebuildTemplate

brand.rebuildTemplate with brand validation and transactional history.

permission: site.adminwrites: brand, pagesclass: transactionundo: yes

Example input

{
  "templateId": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b"
}

Input

Field	Type	Required	Notes
templateId	string	yes	At least 1 character.

Output

Field	Type	Required	Notes
id	string	yes	At least 1 character.
name	string	yes
pageId	string	yes	At least 1 character.
snapshot	object \| null	yes	Default null.
customerSettings	record of array of string \| null	yes	Default null.
status	string	yes	One of "draft", "approved".
version	number	yes
width	number	yes
height	number	yes
createdAt	string	yes
updatedAt	string	yes

Try it

yarn splash brand.rebuildTemplate '{"templateId":"4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b"}' --dry-run

brand.render

brand.render from an approved, curated template through a standalone render boundary.

permission: brand.generatereads onlyclass: external

Example input

{
  "templateId": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "scale": 1
}

Input

Field	Type	Required	Notes
templateId	string	yes	At least 1 character.
presetId	string	no	At least 1 character.
scale	1 \| 2	no	Default 1.
overrides	value	no

Output

Field	Type	Required	Notes
png	string	yes
contentType	"image/png"	yes
filename	string	yes
templateVersion	integer	yes	More than 0.
width	integer	yes	More than 0.
height	integer	yes	More than 0.
warnings	array of string	yes

A dry run refuses an external operation, so it has no dry-run line: run it alone in a batch.

brand.save

brand.save from an approved, curated template through a standalone render boundary.

permission: brand.generatewrites: media, generationsclass: externalundo: yes

Example input

{
  "templateId": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "scale": 2
}

Input

Field	Type	Required	Notes
templateId	string	yes	At least 1 character.
presetId	string	no	At least 1 character.
scale	1 \| 2	no	Default 1.
overrides	value	no

Output

Field	Type	Required	Notes
kind	"template"	yes
media	object	yes
media.id	string (uuid)	yes
media.kind	string	yes	One of "image", "svg", "video", "document".
media.filename	string	yes	At least 1 character. At most 255 characters.
media.mime	string	yes	At least 1 character. At most 127 characters.
media.size	integer	yes	At least 0.
media.url	string	yes	At least 1 character. At most 2048 characters.
media.width	integer	no	At least 1. At most 100000.
media.height	integer	no	At least 1. At most 100000.
media.variants	array of object	yes
media.alt	string \| record of string	yes
media.caption	string \| record of string	no
media.credit	string	no	At most 200 characters.
media.folderId	string (uuid) \| null	no
media.pageCount	integer	no	At least 1.
templateId	string	yes
templateVersion	integer	yes	More than 0.
width	integer	yes	More than 0.
height	integer	yes	More than 0.
warnings	array of string	yes

Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.

A dry run refuses an external operation, so it has no dry-run line: run it alone in a batch.

Generated from the operation registry and the MCP tool catalogue (source 1500d35b708dfe39).

Something wrong on this page? Write to docs@librettocms.com.