Skip to main content

pageEditorSaveBrandGuidelines

Overwrites the brand guideline settings an editor stores for one site and returns true; read the current object from pageEditorGetBrandGuidelines and save it whole. Built-in checks carry id, name, note, updatedBy, condition, definition, example, testContent, enabled, and default; voices carry id, name, updatedBy, color, definition, sample, and enabled. Requires a page editor token for the editor, or a logged-in user who owns the editor or can edit the site.

Page editor

This operation serves the Crazy Egg page editor. Besides personal access tokens, it accepts the page editor's own credential, and it checks access to the editor, page or site involved.

pageEditorSaveBrandGuidelines(
  editorId: String!
  site: String!
  settings: String!
): Boolean

Arguments​

pageEditorSaveBrandGuidelines.editorId ● String! non-null scalar​

Editor UUID from pageEditorCreatePage or pageEditorLatest.

pageEditorSaveBrandGuidelines.site ● String! non-null scalar​

Site hostname such as www.example.com; settings are stored per registrable domain (example.com).

pageEditorSaveBrandGuidelines.settings ● String! non-null scalar​

JSON-encoded object with checks, voices, voiceTestContent, and profile (context, audience), shaped like pageEditorGetBrandGuidelines output; entries reusing a built-in id read back as the default. Example: {"checks":[],"voices":[],"profile":{"context":"","audience":""}}

Type​

Boolean scalar​

The Boolean scalar type represents true or false.