Brand Essentials
Colors, palettes, and font families that define a brand, with every color in multiple representations.
addBrandEssentialsColorBlockColors
Adds Brand Essentials colors to the end of a BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:AddBrandEssentialsColorBlockColorsInput!RequiredBeta
- Required
blockId: ID!,colorIds: [ID!]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
addCustomBrandEssentialsColorBlockColor
Adds a custom color to the end of a BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:AddCustomBrandEssentialsColorBlockColorInput!RequiredBeta
- Required
blockId: ID!,name: String!,representations: BrandEssentialsColorBlockColorRepresentationsInput! - Optional
description: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
createBrandEssentialsColor
Create a new brand essentials color.
Beta
Returns
Arguments
- input:CreateBrandEssentialsColorInput!RequiredBeta
CreateBrandEssentialsColorInputTypeinput argument.- Required
colorPaletteId: ID!,name: String!,representations: BrandEssentialsColorRepresentationsInput! - Optional
description: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColor!
- String!
- ID!
- String
- BrandEssentialsColorRepresentations!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHexColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHslColorRepresentation
- BrandEssentialsLabColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsRgbaColorRepresentation
- BrandEssentialsColorSystemRepresentation
createBrandEssentialsColorPalette
Create a new brand essentials color palette.
Beta
Returns
Arguments
- input:CreateBrandEssentialsColorPaletteInput!RequiredBeta
CreateBrandEssentialsColorPaletteInputTypeinput argument.- Required
brandId: ID!,name: String! - Optional
description: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorPalette!
- String!
- ID!
- DateTime!
- String
- BrandEssentialsColorItems!
- Int!
- Int!
- Int!
- Boolean!
- [BrandEssentialsColor!]!
- String!
- ID!
- String
deleteBrandEssentialsColor
Delete a brand essentials color.
Beta
Returns
Arguments
- input:DeleteBrandEssentialsColorInput!RequiredBeta
DeleteBrandEssentialsColorInputTypeinput argument.- Required
colorId: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
deleteBrandEssentialsColorPalette
Delete a brand essentials color palette.
Beta
Returns
Arguments
- input:DeleteBrandEssentialsColorPaletteInput!RequiredBeta
DeleteBrandEssentialsColorPaletteInputTypeinput argument.- Required
paletteId: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
installBrandEssentialsSelfhostedFontFormats
Install selfhosted font formats to a brand. The font family name, weight and italic style are read from each font file, and files that cannot be installed are reported in errors instead of failing the whole mutation.
Beta
Returns
Arguments
- input:InstallBrandEssentialsSelfhostedFontFormatsInput!RequiredBeta
InstallBrandEssentialsSelfhostedFontFormatsInputinput argument.- Required
brandId: ID!,formats: [InstallBrandEssentialsSelfhostedFontFormatInput!]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- [InstallBrandEssentialsSelfhostedFontFormatError!]!
- InstallBrandEssentialsSelfhostedFontFormatErrorCode!
- ID!
- String!
- [BrandEssentialsFontFamily!]!
- String!
- ID!
- String!
- String!
- [BrandEssentialsFontStyle!]!
- String!
- Boolean!
- Int!
… on BrandEssentialsAdobeFontStyle
- String!
… on BrandEssentialsMonotypeFontStyle
- String!
- String!
… on BrandEssentialsSelfhostedFontStyle
- [BrandEssentialsSelfhostedFontStyleFormat!]!
moveBrandEssentialsColor
Move a brand essentials color to a different palette.
Beta
Returns
Arguments
- input:MoveBrandEssentialsColorInput!RequiredBeta
MoveBrandEssentialsColorInputTypeinput argument.- Required
colorId: ID!,colorPaletteId: ID!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColor!
- String!
- ID!
- String
- BrandEssentialsColorRepresentations!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHexColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHslColorRepresentation
- BrandEssentialsLabColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsRgbaColorRepresentation
- BrandEssentialsColorSystemRepresentation
moveBrandEssentialsColorBlockColor
Moves a BrandEssentialsColorBlockColor within its BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:MoveBrandEssentialsColorBlockColorInput!RequiredBeta
- Required
colorId: ID! - Optional
afterColorId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
removeBrandEssentialsColorBlockColorRepresentation
Removes a representation from a custom BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:RemoveBrandEssentialsColorBlockColorRepresentationInput!RequiredBeta
- Required
colorId: ID!,representationKey: BrandEssentialsColorBlockColorRepresentationKey!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
removeBrandEssentialsColorBlockColors
Removes colors from a BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:RemoveBrandEssentialsColorBlockColorsInput!RequiredBeta
- Required
colorIds: [ID!]!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
removeBrandEssentialsFontFamily
Remove a brand essentials font family.
Beta
Returns
Arguments
- input:RemoveBrandEssentialsFontFamilyInput!RequiredBeta
RemoveBrandEssentialsFontFamilyInputTypeinput argument.- Required
fontFamilyId: ID!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
removeBrandEssentialsFontStyle
Remove a font style from a brand essentials font family.
Beta
Returns
Arguments
- input:RemoveBrandEssentialsFontStyleInput!RequiredBeta
RemoveBrandEssentialsFontStyleInputTypeinput argument.- Required
fontFamilyId: ID!,weight: Int!,isItalic: Boolean!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsFontFamily
- String!
- ID!
- String!
- String!
- [BrandEssentialsFontStyle!]!
- String!
- Boolean!
- Int!
… on BrandEssentialsAdobeFontStyle
- String!
… on BrandEssentialsMonotypeFontStyle
- String!
- String!
… on BrandEssentialsSelfhostedFontStyle
- [BrandEssentialsSelfhostedFontStyleFormat!]!
repositionBrandEssentialsColor
Reposition a brand essentials color within its palette.
Beta
Returns
Arguments
- input:RepositionBrandEssentialsColorInput!RequiredBeta
RepositionBrandEssentialsColorInputTypeinput argument.- Required
colorId: ID!,newPosition: Int!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorPalette!
- String!
- ID!
- DateTime!
- String
- BrandEssentialsColorItems!
- Int!
- Int!
- Int!
- Boolean!
- [BrandEssentialsColor!]!
- String!
- ID!
- String
updateBrandEssentialsColor
Update a brand essentials color.
Beta
Returns
Arguments
- input:UpdateBrandEssentialsColorInput!RequiredBeta
UpdateBrandEssentialsColorInputTypeinput argument.- Required
colorId: ID! - Optional
name: String,description: String,representations: UpdateBrandEssentialsColorRepresentationsInput
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColor!
- String!
- ID!
- String
- BrandEssentialsColorRepresentations!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- String!
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsCmykColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHexColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsHslColorRepresentation
- BrandEssentialsLabColorRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsColorSystemRepresentation
- BrandEssentialsRgbaColorRepresentation
- BrandEssentialsColorSystemRepresentation
updateBrandEssentialsColorBlockColorDescription
Updates the description of a BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT, or TRANSLATE when a locale is given.
Beta
Returns
Arguments
- input:UpdateBrandEssentialsColorBlockColorDescriptionInput!RequiredBeta
- Required
colorId: ID!,description: String! - Optional
locale: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
updateBrandEssentialsColorBlockColorName
Updates the name of a BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT, or TRANSLATE when a locale is given.
Beta
Returns
Arguments
- input:UpdateBrandEssentialsColorBlockColorNameInput!RequiredBeta
- Required
colorId: ID!,name: String! - Optional
locale: String
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
updateBrandEssentialsColorBlockColorRepresentation
Adds or replaces a representation of a custom BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:UpdateBrandEssentialsColorBlockColorRepresentationInput!RequiredBeta
- Required
colorId: ID!,representationKey: BrandEssentialsColorBlockColorRepresentationKey!,value: BrandEssentialsColorBlockColorRepresentationValueInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- [BrandEssentialsColorBlockColor!]!
- String!
- ID!
- ID
- String
- BrandEssentialsColorBlockColorRepresentations!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
updateBrandEssentialsColorPalette
Update a brand essentials color palette.
Beta
Returns
Arguments
- input:UpdateBrandEssentialsColorPaletteInput!RequiredBeta
UpdateBrandEssentialsColorPaletteInputTypeinput argument.- Required
paletteId: ID! - Optional
name: String,description: String,hiddenColorRepresentationKeys: [BrandEssentialsColorRepresentationKey!]
Response fields
0 selected
Toggle fields to tailor the query and response.
- BrandEssentialsColorPalette!
- String!
- ID!
- DateTime!
- String
- BrandEssentialsColorItems!
- Int!
- Int!
- Int!
- Boolean!
- [BrandEssentialsColor!]!
- String!
- ID!
- String