Guideline documents, pages, sections, and blocks — the structure behind a published brand portal.

Query

guidelineNavigationItem

Retrieve a single Guideline navigation item by the Id of any navigation item type. Returns null when the item does not exist or is not visible to the requester.

Beta

Returns

GuidelineNavigationItem

Arguments

id:ID!RequiredBeta
Id of any Guideline navigation item.
language:String = nullOptionalBeta
Language code the navigation item is read in, e.g. EN or DE.

Response fields

8 selected

Toggle fields to tailor the query and response.

  • … on GuidelineCoverPageNavigationItem

    • String!
    • ID!
    • String!
  • … on GuidelineDocumentGroupNavigationItem

    • String!
    • ID!
    • Boolean!
  • … on GuidelineDocumentLibraryNavigationItem

    • String!
    • ID!
    • Boolean!
    • String!
  • … on GuidelineDocumentLinkNavigationItem

    • String!
    • ID!
    • GuidelineDocumentLinkDisplayMode
    • ID
    • String
    • GuidelineDocumentLinkIconPosition
  • … on GuidelineDocumentNavigationItem

    • String!
    • ID!
    • Boolean!
    • String!
  • … on GuidelineDocumentPageCategoryNavigationItem

    • String!
    • ID!
    • String!
  • … on GuidelineDocumentPageLinkNavigationItem

    • String!
    • ID!
    • GuidelineDocumentLinkDisplayMode
    • ID
    • String
    • GuidelineDocumentLinkIconPosition
  • … on GuidelineDocumentPageNavigationItem

    • String!
    • ID!
    • Boolean!
    • Boolean!
    • String!
Query

guidelinePage

Retrieve a GuidelinePage by its id.

Beta

Returns

GuidelinePage

Arguments

id:ID!RequiredBeta
The id of the GuidelinePage to retrieve.
locale:StringOptionalBeta
The locale tag ("de", "de-DE") in which the GuidelinePage should be delivered. If the requested locale is unavailable, the default language will be used as a fallback.
language:LanguageCodeOptionalBeta
Specifies the language in which the GuidelinePage should be delivered. If the requested language is unavailable, the default language will be used as a fallback.

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • DateTime!
  • String!
  • Url!
Query

guidelinePageBlock

Retrieve a GuidelinePageBlock by its id.

Beta

Returns

GuidelinePageBlockInterface

Arguments

id:ID!RequiredBeta
The id of the GuidelinePageBlock to retrieve.
locale:StringOptionalBeta
The locale tag ("de", "de-DE") in which the GuidelinePageBlock should be delivered. If the requested locale is unavailable, the default language will be used as a fallback.
language:LanguageCodeOptionalBeta
Specifies the language in which the GuidelinePageBlock should be delivered. If the requested language is unavailable, the default language will be used as a fallback.

Response fields

1 selected

Toggle fields to tailor the query and response.

  • String
  • ID!
  • DateTime!
  • JsonObject
  • Url!
Mutation

changeDefaultColorScheme

Change the default color scheme of a guideline.

Beta

Returns

ChangeDefaultColorScheme

Arguments

input:ChangeDefaultColorSchemeInput!RequiredBeta
ChangeDefaultColorSchemeInputType input argument.
RequiredcolorSchemeId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createColorScheme

Create a new Color Scheme.

Beta

Returns

CreateColorScheme

Arguments

input:CreateColorSchemeInput!RequiredBeta
CreateColorSchemeInputType input argument.
RequiredguidelineId: ID!, data: CreateColorSchemeDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createGuidelineDocument

Beta

Returns

CreateGuidelineDocument

Arguments

input:CreateGuidelineDocumentInput!RequiredBeta
RequiredparentId: ID!, title: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

createGuidelineDocumentGroup

Beta

Returns

CreateGuidelineDocumentGroup

Arguments

input:CreateGuidelineDocumentGroupInput!RequiredBeta
RequiredparentId: ID!, title: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

createGuidelineDocumentLibrary

Beta

Returns

CreateGuidelineDocumentLibrary

Arguments

input:CreateGuidelineDocumentLibraryInput!RequiredBeta
RequiredparentId: ID!, title: String!, libraryId: ID!
Optionalheading: String, subheading: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • String!
  • ID!
  • String!
  • String
Mutation

createGuidelineDocumentPage

Beta

Returns

CreateGuidelineDocumentPage

Arguments

input:CreateGuidelineDocumentPageInput!RequiredBeta
RequiredparentId: ID!, title: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID
  • ID!
  • ID!
  • String!
Mutation

createGuidelineDocumentPageCategory

Beta

Returns

CreateGuidelineDocumentPageCategory

Arguments

input:CreateGuidelineDocumentPageCategoryInput!RequiredBeta
RequiredparentId: ID!, title: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

createGuidelinePageBlock

Creates a new GuidelinePageBlock. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

CreateGuidelinePageBlock

Arguments

input:CreateGuidelinePageBlockInput!RequiredBeta
CreateGuidelinePageBlock input argument.
RequiredblockTypeId: ID!, settings: JsonObject!, sectionId: ID!
OptionalafterElementId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createGuidelinePageHeading

Creates a new GuidelinePageHeading. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

CreateGuidelinePageHeading

Arguments

input:CreateGuidelinePageHeadingInput!RequiredBeta
CreateGuidelinePageHeading input argument.
RequiredsectionId: ID!
Optionaltitle: String!, afterElementId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createGuidelinePageSection

Creates a new GuidelinePageSection, either on top of a page or after a given section.

Beta

Returns

CreateGuidelinePageSection

Arguments

input:CreateGuidelinePageSectionInput!RequiredBeta
CreateGuidelinePageSectionInput input argument.
RequiredpageId: ID!
OptionalafterGuidelinePageSectionId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

deleteColorScheme

Delete a Color Scheme.

Beta

Returns

DeleteColorScheme

Arguments

input:DeleteColorSchemeInput!RequiredBeta
DeleteColorSchemeInputType input argument.
RequiredcolorSchemeId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

  • String!
Mutation

deleteGuidelineDocument

Beta

Returns

DeleteGuidelineDocument

Arguments

input:DeleteGuidelineDocumentInput!RequiredBeta
Requiredid: ID!
OptionalfailIfHasChildren: Boolean!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelineDocumentGroup

Beta

Returns

DeleteGuidelineDocumentGroup

Arguments

input:DeleteGuidelineDocumentGroupInput!RequiredBeta
Requiredid: ID!
OptionalfailIfHasChildren: Boolean!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelineDocumentLibrary

Beta

Returns

DeleteGuidelineDocumentLibrary

Arguments

input:DeleteGuidelineDocumentLibraryInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelineDocumentPage

Beta

Returns

DeleteGuidelineDocumentPage

Arguments

input:DeleteGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!
OptionalfailIfHasChildren: Boolean!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelineDocumentPageCategory

Beta

Returns

DeleteGuidelineDocumentPageCategory

Arguments

input:DeleteGuidelineDocumentPageCategoryInput!RequiredBeta
Requiredid: ID!
OptionalfailIfHasChildren: Boolean!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelinePageHeading

Deletes a GuidelinePageHeading by the given id. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

DeleteGuidelinePageHeading

Arguments

input:DeleteGuidelinePageHeadingInput!RequiredBeta
DeleteGuidelinePageHeading input argument.
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteGuidelinePageSection

Deletes a GuidelinePageSection.

Beta

Returns

DeleteGuidelinePageSection

Arguments

input:DeleteGuidelinePageSectionInput!RequiredBeta
DeleteGuidelinePageSectionInput input argument.
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • … on DeleteGuidelinePageSectionSuccessful

    • ID!
  • … on DeleteGuidelinePageSectionReferenced

Mutation

duplicateColorScheme

Duplicate a Color Scheme.

Beta

Returns

DuplicateColorScheme

Arguments

input:DuplicateColorSchemeInput!RequiredBeta
DuplicateColorSchemeInputType input argument.
RequiredcolorSchemeId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

duplicateGuidelineDocumentPage

Beta

Returns

DuplicateGuidelineDocumentPage

Arguments

input:DuplicateGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String!
Mutation

hideGuidelineDocumentFromNavigation

Beta

Returns

HideGuidelineDocumentFromNavigation

Arguments

input:HideGuidelineDocumentFromNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

hideGuidelineDocumentGroupFromNavigation

Beta

Returns

HideGuidelineDocumentGroupFromNavigation

Arguments

input:HideGuidelineDocumentGroupFromNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

hideGuidelineDocumentLibraryFromNavigation

Beta

Returns

HideGuidelineDocumentLibraryFromNavigation

Arguments

input:HideGuidelineDocumentLibraryFromNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

hideGuidelineDocumentPageFromNavigation

Beta

Returns

HideGuidelineDocumentPageFromNavigation

Arguments

input:HideGuidelineDocumentPageFromNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

moveGuidelineDocumentPage

Beta

Returns

MoveGuidelineDocumentPage

Arguments

input:MoveGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!, targetParentId: ID!
Optionalsort: Int

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

publishGuidelineDocumentPage

Beta

Returns

PublishGuidelineDocumentPage

Arguments

input:PublishGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

showGuidelineDocumentGroupInNavigation

Beta

Returns

ShowGuidelineDocumentGroupInNavigation

Arguments

input:ShowGuidelineDocumentGroupInNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

showGuidelineDocumentInNavigation

Beta

Returns

ShowGuidelineDocumentInNavigation

Arguments

input:ShowGuidelineDocumentInNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

showGuidelineDocumentLibraryInNavigation

Beta

Returns

ShowGuidelineDocumentLibraryInNavigation

Arguments

input:ShowGuidelineDocumentLibraryInNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

showGuidelineDocumentPageInNavigation

Beta

Returns

ShowGuidelineDocumentPageInNavigation

Arguments

input:ShowGuidelineDocumentPageInNavigationInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

unpublishGuidelineDocumentPage

Beta

Returns

UnpublishGuidelineDocumentPage

Arguments

input:UnpublishGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • Boolean!
Mutation

updateColorScheme

Update a Color Scheme.

Beta

Returns

UpdateColorScheme

Arguments

input:UpdateColorSchemeInput!RequiredBeta
UpdateColorSchemeInputType input argument.
RequiredcolorSchemeId: ID!, data: UpdateColorSchemeDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsAccentColor

Update an existing Accent Color of a Color Scheme.

Beta

Returns

UpdateGuidelineDesignSettingsAccentColor

Arguments

input:UpdateGuidelineDesignSettingsAccentColorInput!RequiredBeta
UpdateGuidelineDesignSettingsAccentColorInputType input argument.
RequiredcolorSchemeId: ID!, data: UpdateGuidelineDesignSettingsAccentColorDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsBackgroundColor

Update the Background Color of a Color Scheme.

Beta

Returns

UpdateGuidelineDesignSettingsBackgroundColor

Arguments

input:UpdateGuidelineDesignSettingsBackgroundColorInput!RequiredBeta
UpdateGuidelineDesignSettingsBackgroundColorInputType input argument.
RequiredcolorSchemeId: ID!, data: UpdateGuidelineDesignSettingsBackgroundColorDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsBulletListStyleColors

Update existing Bullet List Style Colors of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsBulletListStyleColors

Arguments

input:UpdateGuidelineDesignSettingsBulletListStyleColorsInput!RequiredBeta
UpdateGuidelineDesignSettingsBulletListStyleColorsType input argument.
RequiredguidelineId: ID!, colorSchemeId: String!, data: [UpdateGuidelineDesignSettingsBulletListStyleColorsDataInput]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsBulletListStyles

Update existing Bullet List Styles of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsBulletListStyles

Arguments

input:UpdateGuidelineDesignSettingsBulletListStylesInput!RequiredBeta
UpdateGuidelineDesignSettingsBulletListStylesType input argument.
RequiredguidelineId: ID!, data: [UpdateGuidelineDesignSettingsBulletListStylesDataInput]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsButtonStyle

Update an existing Button Style of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsButtonStyle

Arguments

input:UpdateGuidelineDesignSettingsButtonStyleInput!RequiredBeta
UpdateGuidelineDesignSettingsButtonStyleInputType input argument.
RequiredguidelineId: ID!, data: UpdateGuidelineDesignSettingsButtonStyleDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsButtonStyleColor

Update an existing Button Style Color of a Color Scheme.

Beta

Returns

UpdateGuidelineDesignSettingsButtonStyleColor

Arguments

input:UpdateGuidelineDesignSettingsButtonStyleColorInput!RequiredBeta
UpdateGuidelineDesignSettingsButtonStyleColorInputType input argument.
RequiredcolorSchemeId: ID!, data: UpdateGuidelineDesignSettingsButtonStyleColorDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsMainFontFamily

Update an existing Main Font Family of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsMainFontFamily

Arguments

input:UpdateGuidelineDesignSettingsMainFontFamilyInput!RequiredBeta
UpdateGuidelineDesignSettingsMainFontFamilyInputType input argument.
RequiredguidelineId: ID!, mainFontFamily: GuidelineDesignSettingsTypeStyleFontFamilyInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsNumberedListStyleColors

Update existing Numbered List Style Colors of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsNumberedListStyleColors

Arguments

input:UpdateGuidelineDesignSettingsNumberedListStyleColorsInput!RequiredBeta
UpdateGuidelineDesignSettingsNumberedListStyleColorsType input argument.
RequiredguidelineId: ID!, colorSchemeId: String!, data: [UpdateGuidelineDesignSettingsNumberedListStyleColorsDataInput]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsNumberedListStyles

Update existing Numbered List Styles of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsNumberedListStyles

Arguments

input:UpdateGuidelineDesignSettingsNumberedListStylesInput!RequiredBeta
UpdateGuidelineDesignSettingsNumberedListStylesType input argument.
RequiredguidelineId: ID!, data: [UpdateGuidelineDesignSettingsNumberedListStylesDataInput]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsTypeStyle

Update an existing Type Style of a Guideline.

Beta

Returns

UpdateGuidelineDesignSettingsTypeStyle

Arguments

input:UpdateGuidelineDesignSettingsTypeStyleInput!RequiredBeta
UpdateGuidelineDesignSettingsTypeStyleInputType input argument.
RequiredguidelineId: ID!, data: UpdateGuidelineDesignSettingsTypeStyleDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDesignSettingsTypeStyleColor

Update an existing Type Style Color of a Color Scheme.

Beta

Returns

UpdateGuidelineDesignSettingsTypeStyleColor

Arguments

input:UpdateGuidelineDesignSettingsTypeStyleColorInput!RequiredBeta
UpdateGuidelineDesignSettingsTypeStyleColorInputType input argument.
RequiredcolorSchemeId: ID!, data: UpdateGuidelineDesignSettingsTypeStyleColorDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelineDocument

Beta

Returns

UpdateGuidelineDocument

Arguments

input:UpdateGuidelineDocumentInput!RequiredBeta
Requiredid: ID!, title: String!
Optionallanguage: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

updateGuidelineDocumentGroup

Beta

Returns

UpdateGuidelineDocumentGroup

Arguments

input:UpdateGuidelineDocumentGroupInput!RequiredBeta
Requiredid: ID!, title: String!
Optionallanguage: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

updateGuidelineDocumentLibrary

Beta

Returns

UpdateGuidelineDocumentLibrary

Arguments

input:UpdateGuidelineDocumentLibraryInput!RequiredBeta
Requiredid: ID!, title: String!
Optionallanguage: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

updateGuidelineDocumentPage

Beta

Returns

UpdateGuidelineDocumentPage

Arguments

input:UpdateGuidelineDocumentPageInput!RequiredBeta
Requiredid: ID!
Optionallanguage: String, title: String, heading: String, subheading: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • String
  • ID!
  • String
  • String
Mutation

updateGuidelineDocumentPageCategory

Beta

Returns

UpdateGuidelineDocumentPageCategory

Arguments

input:UpdateGuidelineDocumentPageCategoryInput!RequiredBeta
Requiredid: ID!, title: String!
Optionallanguage: String

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
  • String
Mutation

updateGuidelinePageBlockSettings

Updates the settings of a GuidelinePageBlock in the specified language. Only fields provided in the input are modified.

Beta

Returns

UpdateGuidelinePageBlockSettings

Arguments

input:UpdateGuidelinePageBlockSettingsInput!RequiredBeta
UpdateGuidelinePageBlockSettingsInput input argument.
Requiredid: ID!, settings: JsonObject!
Optionallocale: String, language: LanguageCode

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelinePageHeading

Updates the properties of an existing GuidelinePageHeading. Requires basic:write scope to be accessible and Project permission level EDIT, or TRANSLATE when a locale or language is given.

Beta

Returns

UpdateGuidelinePageHeading

Arguments

input:UpdateGuidelinePageHeadingInput!RequiredBeta
UpdateGuidelinePageHeading input argument.
Requiredid: ID!, data: UpdateGuidelinePageHeadingDataInput!
Optionallanguage: LanguageCode, locale: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateGuidelinePageSection

Updates the properties of an existing GuidelinePageSection.

Beta

Returns

UpdateGuidelinePageSection

Arguments

input:UpdateGuidelinePageSectionInput!RequiredBeta
UpdateGuidelinePageSectionInput input argument.
Requiredid: ID!, data: UpdateGuidelinePageSectionDataInput!
Optionallocale: String

Response fields

0 selected

Toggle fields to tailor the query and response.