Guidelines
Guideline documents, pages, sections, and blocks — the structure behind a published brand portal.
guidelinePage
Retrieve a GuidelinePage by its id.
Beta
Returns
Arguments
- id:ID!RequiredBeta
- The id of the
GuidelinePageto 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!
- GuidelinePageSectionItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSection]
- ID!
- GuidelinePageSectionElementItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSectionElement]
… on GuidelinePageHeading
- String!
- ID!
- GuidelinePageHeadingAlignment!
- Boolean!
- Boolean!
- DateTime!
- Boolean!
- GuidelinePageHeadingTypeStyle!
- Url!
… on GuidelinePageBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on BrandEssentialsColorBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on LibraryBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on GuidelinePageBlockReference
- ID!
- GuidelinePageTheme
- JsonObject!
- JsonObject!
- JsonObject!
- String!
- Url!
guidelinePageBlock
Retrieve a GuidelinePageBlock by its id.
Beta
Returns
Arguments
- id:ID!RequiredBeta
- The id of the
GuidelinePageBlockto 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.
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- GuidelinePageBlockAssetItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAsset]!
- Url!
- String
- ID!
- DateTime!
- JsonObject
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
- Url!
… on BrandEssentialsColorBlock
- [BrandEssentialsColorBlockColor!]!
changeDefaultColorScheme
Change the default color scheme of a guideline.
Beta
Returns
Arguments
- input:ChangeDefaultColorSchemeInput!RequiredBeta
ChangeDefaultColorSchemeInputTypeinput argument.- Required
colorSchemeId: ID!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
createColorScheme
Create a new Color Scheme.
Beta
Returns
Arguments
- input:CreateColorSchemeInput!RequiredBeta
CreateColorSchemeInputTypeinput argument.- Required
guidelineId: ID!,data: CreateColorSchemeDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
createGuidelineDocument
Beta
Returns
Arguments
- input:CreateGuidelineDocumentInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentGroup
Beta
Returns
Arguments
- input:CreateGuidelineDocumentGroupInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentLibrary
Beta
Returns
Arguments
- input:CreateGuidelineDocumentLibraryInput!RequiredBeta
- Required
parentId: ID!,title: String!,libraryId: ID! - Optional
heading: String,subheading: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- String!
- ID!
- String!
- String
createGuidelineDocumentLink
Beta
Returns
Arguments
- input:CreateGuidelineDocumentLinkInput!RequiredBeta
- Required
parentId: ID!,title: String!,url: String!,openNewTab: Boolean! - Optional
displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String!
- String!
createGuidelineDocumentPage
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID
- ID!
- ID!
- String!
createGuidelineDocumentPageCategory
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageCategoryInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentPageLink
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageLinkInput!RequiredBeta
- Required
parentId: ID!,title: String!,url: String!,openNewTab: Boolean! - Optional
displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String
- String
createGuidelinePageBlock
Creates a new GuidelinePageBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:CreateGuidelinePageBlockInput!RequiredBeta
CreateGuidelinePageBlockinput argument.- Required
blockTypeId: ID!,settings: JsonObject!,sectionId: ID! - Optional
afterElementId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
createGuidelinePageHeading
Creates a new GuidelinePageHeading. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:CreateGuidelinePageHeadingInput!RequiredBeta
CreateGuidelinePageHeadinginput argument.- Required
sectionId: ID! - Optional
title: String!,afterElementId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageHeading!
- String!
- ID!
- GuidelinePageHeadingAlignment!
- Boolean!
- Boolean!
- DateTime!
- Boolean!
- GuidelinePageHeadingTypeStyle!
- Url!
createGuidelinePageSection
Creates a new GuidelinePageSection, either on top of a page or after a given section.
Beta
Returns
Arguments
- input:CreateGuidelinePageSectionInput!RequiredBeta
CreateGuidelinePageSectionInputinput argument.- Required
pageId: ID! - Optional
afterGuidelinePageSectionId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageSection!
- ID!
- GuidelinePageSectionElementItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSectionElement]
… on GuidelinePageHeading
- String!
- ID!
- GuidelinePageHeadingAlignment!
- Boolean!
- Boolean!
- DateTime!
- Boolean!
- GuidelinePageHeadingTypeStyle!
- Url!
… on GuidelinePageBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on BrandEssentialsColorBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on LibraryBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on GuidelinePageBlockReference
- ID!
deleteColorScheme
Delete a Color Scheme.
Beta
Returns
Arguments
- input:DeleteColorSchemeInput!RequiredBeta
DeleteColorSchemeInputTypeinput argument.- Required
colorSchemeId: ID!
Response fields
0 selected
Toggle fields to tailor the query and response.
- String!
deleteGuidelineDocument
Beta
Returns
Arguments
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentGroup
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentGroupInput!RequiredBeta
- Required
id: ID! - Optional
failIfHasChildren: Boolean!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentLibrary
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentLibraryInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentLink
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentLinkInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentPage
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID! - Optional
failIfHasChildren: Boolean!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentPageCategory
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentPageCategoryInput!RequiredBeta
- Required
id: ID! - Optional
failIfHasChildren: Boolean!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelineDocumentPageLink
Beta
Returns
Arguments
- input:DeleteGuidelineDocumentPageLinkInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelinePageHeading
Deletes a GuidelinePageHeading by the given id. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:DeleteGuidelinePageHeadingInput!RequiredBeta
DeleteGuidelinePageHeadinginput argument.- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteGuidelinePageSection
Deletes a GuidelinePageSection.
Beta
Returns
Arguments
- input:DeleteGuidelinePageSectionInput!RequiredBeta
DeleteGuidelinePageSectionInputinput argument.- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
… on DeleteGuidelinePageSectionSuccessful
- ID!
… on DeleteGuidelinePageSectionReferenced
- [GuidelinePageBlockLocation!]!
- [String!]!
- Url!
duplicateColorScheme
Duplicate a Color Scheme.
Beta
Returns
Arguments
- input:DuplicateColorSchemeInput!RequiredBeta
DuplicateColorSchemeInputTypeinput argument.- Required
colorSchemeId: ID!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
duplicateGuidelineDocument
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String!
duplicateGuidelineDocumentGroup
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentGroupInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
duplicateGuidelineDocumentLibrary
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentLibraryInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String!
duplicateGuidelineDocumentLink
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentLinkInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String!
duplicateGuidelineDocumentPage
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String!
duplicateGuidelineDocumentPageCategory
Beta
Returns
Arguments
- input:DuplicateGuidelineDocumentPageCategoryInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String!
moveGuidelineDocumentPage
Beta
Returns
Arguments
- input:MoveGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID!,targetParentId: ID! - Optional
sort: Int
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
moveGuidelineDocumentPageThemeSettingsToGuideline
Moves the theme settings and template assets of a guideline document page to all pages of its guideline: moves those of settingKeys into the shared ones, overriding those of the same key, then clears the page. Settings the theme schema does not allow are dropped; values it rejects are moved anyway. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:MoveGuidelineDocumentPageThemeSettingsToGuidelineInput!RequiredBeta
- Required
id: ID! - Optional
settingKeys: [String!]
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineTheme!
- GuidelineThemeTemplateSettings!
- JsonObject!
- JsonObject!
- JsonObject!
- GuidelineThemeTemplateSettingsSchemas!
- JsonObject
- JsonObject
- JsonObject
- GuidelinePageTheme
- JsonObject!
- JsonObject!
- JsonObject!
moveGuidelineLibraryPageThemeSettingsToGuideline
Moves the theme settings and template assets of a guideline library page to all library pages of its guideline: moves those of settingKeys into the shared ones, overriding those of the same key, then clears the page. Settings the theme schema does not allow are dropped; values it rejects are moved anyway. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:MoveGuidelineLibraryPageThemeSettingsToGuidelineInput!RequiredBeta
- Required
id: ID! - Optional
settingKeys: [String!]
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineTheme!
- GuidelineThemeTemplateSettings!
- JsonObject!
- JsonObject!
- JsonObject!
- GuidelineThemeTemplateSettingsSchemas!
- JsonObject
- JsonObject
- JsonObject
- GuidelineLibraryPageTheme
- JsonObject!
- JsonObject!
- JsonObject!
publishGuidelineDocumentPage
Beta
Returns
Arguments
- input:PublishGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- Boolean!
removeGuidelineDocumentPageThemeSettingsOverrides
Removes the theme settings overrides of a guideline document page, so it uses the theme settings of its guideline again. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:RemoveGuidelineDocumentPageThemeSettingsOverridesInput!RequiredBeta
- Required
id: ID! - Optional
settingKeys: [String!]
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageTheme
- JsonObject!
- JsonObject!
- JsonObject!
removeGuidelineLibraryPageThemeSettingsOverrides
Removes the theme settings overrides of a guideline library page, so it uses the theme settings of its guideline again. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:RemoveGuidelineLibraryPageThemeSettingsOverridesInput!RequiredBeta
- Required
id: ID! - Optional
settingKeys: [String!]
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineLibraryPageTheme
- JsonObject!
- JsonObject!
- JsonObject!
unpublishGuidelineDocumentPage
Beta
Returns
Arguments
- input:UnpublishGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- Boolean!
updateColorScheme
Update a Color Scheme.
Beta
Returns
Arguments
- input:UpdateColorSchemeInput!RequiredBeta
UpdateColorSchemeInputTypeinput argument.- Required
colorSchemeId: ID!,data: UpdateColorSchemeDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
updateGuidelineCoverPageThemeSettings
Partially updates the theme settings of a guideline cover page. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:UpdateGuidelineCoverPageThemeSettingsInput!RequiredBeta
- Required
guidelineId: ID!,themeSettings: JsonObject!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineTheme!
- GuidelineThemeTemplateSettings!
- JsonObject!
- JsonObject!
- JsonObject!
- GuidelineThemeTemplateSettingsSchemas!
- JsonObject
- JsonObject
- JsonObject
updateGuidelineDesignSettingsAccentColor
Update an existing Accent Color of a Color Scheme.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsAccentColorInput!RequiredBeta
UpdateGuidelineDesignSettingsAccentColorInputTypeinput argument.- Required
colorSchemeId: ID!,data: UpdateGuidelineDesignSettingsAccentColorDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsAccentColor!
- String!
- [GuidelineDesignSettingsColor]!
- String!
- String!
- Boolean!
updateGuidelineDesignSettingsBackgroundColor
Update the Background Color of a Color Scheme.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsBackgroundColorInput!RequiredBeta
UpdateGuidelineDesignSettingsBackgroundColorInputTypeinput argument.- Required
colorSchemeId: ID!,data: UpdateGuidelineDesignSettingsBackgroundColorDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [GuidelineDesignSettingsBackgroundColor]!
- String
- String!
- Boolean!
updateGuidelineDesignSettingsBulletListStyleColors
Update existing Bullet List Style Colors of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsBulletListStyleColorsInput!RequiredBeta
UpdateGuidelineDesignSettingsBulletListStyleColorsTypeinput argument.- Required
guidelineId: ID!,colorSchemeId: String!,data: [UpdateGuidelineDesignSettingsBulletListStyleColorsDataInput]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [GuidelineDesignSettingsBulletListStyle]!
- Int!
- String!
- String!
- [GuidelineDesignSettingsListStyleColor]!
- String
- String!
- Boolean!
updateGuidelineDesignSettingsBulletListStyles
Update existing Bullet List Styles of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsBulletListStylesInput!RequiredBeta
UpdateGuidelineDesignSettingsBulletListStylesTypeinput argument.- Required
guidelineId: ID!,data: [UpdateGuidelineDesignSettingsBulletListStylesDataInput]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [GuidelineDesignSettingsBulletListStyle]!
- Int!
- String!
- String!
- [GuidelineDesignSettingsListStyleColor]!
- String
- String!
- Boolean!
updateGuidelineDesignSettingsButtonStyle
Update an existing Button Style of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsButtonStyleInput!RequiredBeta
UpdateGuidelineDesignSettingsButtonStyleInputTypeinput argument.- Required
guidelineId: ID!,data: UpdateGuidelineDesignSettingsButtonStyleDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsButtonStyle!
- String!
- String!
- String!
- String!
- Boolean!
- Boolean!
- String!
- String!
- String!
- String!
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
updateGuidelineDesignSettingsButtonStyleColor
Update an existing Button Style Color of a Color Scheme.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsButtonStyleColorInput!RequiredBeta
UpdateGuidelineDesignSettingsButtonStyleColorInputTypeinput argument.- Required
colorSchemeId: ID!,data: UpdateGuidelineDesignSettingsButtonStyleColorDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsButtonStyle!
- String!
- String!
- String!
- String!
- Boolean!
- Boolean!
- String!
- String!
- String!
- String!
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
updateGuidelineDesignSettingsMainFontFamily
Update an existing Main Font Family of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsMainFontFamilyInput!RequiredBeta
UpdateGuidelineDesignSettingsMainFontFamilyInputTypeinput argument.- Required
guidelineId: ID!,mainFontFamily: GuidelineDesignSettingsTypeStyleFontFamilyInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsTypeStyleFontFamily!
- String!
- String!
updateGuidelineDesignSettingsNumberedListStyleColors
Update existing Numbered List Style Colors of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsNumberedListStyleColorsInput!RequiredBeta
UpdateGuidelineDesignSettingsNumberedListStyleColorsTypeinput argument.- Required
guidelineId: ID!,colorSchemeId: String!,data: [UpdateGuidelineDesignSettingsNumberedListStyleColorsDataInput]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [GuidelineDesignSettingsNumberedListStyle]!
- Int!
- String!
- [GuidelineDesignSettingsListStyleColor]!
- String
- String!
- Boolean!
updateGuidelineDesignSettingsNumberedListStyles
Update existing Numbered List Styles of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsNumberedListStylesInput!RequiredBeta
UpdateGuidelineDesignSettingsNumberedListStylesTypeinput argument.- Required
guidelineId: ID!,data: [UpdateGuidelineDesignSettingsNumberedListStylesDataInput]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [GuidelineDesignSettingsNumberedListStyle]!
- Int!
- String!
- [GuidelineDesignSettingsListStyleColor]!
- String
- String!
- Boolean!
updateGuidelineDesignSettingsTypeStyle
Update an existing Type Style of a Guideline.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsTypeStyleInput!RequiredBeta
UpdateGuidelineDesignSettingsTypeStyleInputTypeinput argument.- Required
guidelineId: ID!,data: UpdateGuidelineDesignSettingsTypeStyleDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsTypeStylesType!
… on GuidelineDesignSettingsBlockTypeStyle
- String!
- String!
- Boolean!
- Boolean!
- Boolean!
- String!
- String!
- String!
- String!
- String!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
… on GuidelineDesignSettingsInlineTypeStyle
- String!
- String!
- Boolean!
- Boolean!
- Boolean!
- String!
- String!
- String!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
updateGuidelineDesignSettingsTypeStyleColor
Update an existing Type Style Color of a Color Scheme.
Beta
Returns
Arguments
- input:UpdateGuidelineDesignSettingsTypeStyleColorInput!RequiredBeta
UpdateGuidelineDesignSettingsTypeStyleColorInputTypeinput argument.- Required
colorSchemeId: ID!,data: UpdateGuidelineDesignSettingsTypeStyleColorDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineDesignSettingsTypeStylesType!
… on GuidelineDesignSettingsBlockTypeStyle
- String!
- String!
- Boolean!
- Boolean!
- Boolean!
- String!
- String!
- String!
- String!
- String!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
… on GuidelineDesignSettingsInlineTypeStyle
- String!
- String!
- Boolean!
- Boolean!
- Boolean!
- String!
- String!
- String!
- GuidelineDesignSettingsTypeStyleFontFamily
- String!
- String!
- [GuidelineDesignSettingsTypeStyleTextColor]!
- String!
- String!
- Boolean!
updateGuidelineDocument
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentInput!RequiredBeta
- Required
id: ID!,title: String! - Optional
language: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
updateGuidelineDocumentGroup
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentGroupInput!RequiredBeta
- Required
id: ID!,title: String! - Optional
language: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
updateGuidelineDocumentLibrary
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentLibraryInput!RequiredBeta
- Required
id: ID!,title: String! - Optional
language: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
updateGuidelineDocumentLink
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentLinkInput!RequiredBeta
- Required
id: ID! - Optional
language: String,title: String,url: String,openNewTab: Boolean,displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String
- String
updateGuidelineDocumentPage
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentPageInput!RequiredBeta
- Required
id: ID! - Optional
language: String,title: String,heading: String,subheading: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- String
- ID!
- String
- String
updateGuidelineDocumentPageCategory
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentPageCategoryInput!RequiredBeta
- Required
id: ID!,title: String! - Optional
language: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
updateGuidelineDocumentPageLink
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentPageLinkInput!RequiredBeta
- Required
id: ID! - Optional
language: String,title: String,url: String,openNewTab: Boolean,displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String
- String
updateGuidelineDocumentPageThemeSettings
Partially updates the theme settings of a guideline document page. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:UpdateGuidelineDocumentPageThemeSettingsInput!RequiredBeta
- Required
id: ID!,themeSettings: JsonObject!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageTheme
- JsonObject!
- JsonObject!
- JsonObject!
updateGuidelineLibraryPageThemeSettings
Partially updates the theme settings of a guideline library page. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:UpdateGuidelineLibraryPageThemeSettingsInput!RequiredBeta
- Required
id: ID!,themeSettings: JsonObject!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineLibraryPageTheme
- JsonObject!
- JsonObject!
- JsonObject!
updateGuidelinePageBlockSettings
Updates the settings of a GuidelinePageBlock in the specified language. Only fields provided in the input are modified.
Beta
Returns
Arguments
- input:UpdateGuidelinePageBlockSettingsInput!RequiredBeta
UpdateGuidelinePageBlockSettingsInputinput argument.- Required
id: ID!,settings: JsonObject! - Optional
locale: String,language: LanguageCode
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
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
Arguments
- input:UpdateGuidelinePageHeadingInput!RequiredBeta
UpdateGuidelinePageHeadinginput argument.- Required
id: ID!,data: UpdateGuidelinePageHeadingDataInput! - Optional
language: LanguageCode,locale: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageHeading!
- String!
- ID!
- GuidelinePageHeadingAlignment!
- Boolean!
- Boolean!
- DateTime!
- Boolean!
- GuidelinePageHeadingTypeStyle!
- Url!
updateGuidelinePageSection
Updates the properties of an existing GuidelinePageSection.
Beta
Returns
Arguments
- input:UpdateGuidelinePageSectionInput!RequiredBeta
UpdateGuidelinePageSectionInputinput argument.- Required
id: ID!,data: UpdateGuidelinePageSectionDataInput! - Optional
locale: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageSection!
- ID!
- GuidelinePageSectionElementItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSectionElement]
… on GuidelinePageHeading
- String!
- ID!
- GuidelinePageHeadingAlignment!
- Boolean!
- Boolean!
- DateTime!
- Boolean!
- GuidelinePageHeadingTypeStyle!
- Url!
… on GuidelinePageBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on BrandEssentialsColorBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on LibraryBlock
- ID!
- String
- DateTime!
- JsonObject
- Url!
… on GuidelinePageBlockReference
- ID!
updateGuidelineThemeSettings
Partially updates the theme settings shared by all library pages and pages of a guideline. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:UpdateGuidelineThemeSettingsInput!RequiredBeta
- Required
guidelineId: ID! - Optional
librarySettings: JsonObject,documentPageSettings: JsonObject
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineTheme!
- GuidelineThemeTemplateSettings!
- JsonObject!
- JsonObject!
- JsonObject!
- GuidelineThemeTemplateSettingsSchemas!
- JsonObject
- JsonObject
- JsonObject