Colors, palettes, and font families that define a brand, with every color in multiple representations.

Mutation

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

AddBrandEssentialsColorBlockColors

Arguments

input:AddBrandEssentialsColorBlockColorsInput!RequiredBeta
RequiredblockId: ID!, colorIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

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

AddCustomBrandEssentialsColorBlockColor

Arguments

input:AddCustomBrandEssentialsColorBlockColorInput!RequiredBeta
RequiredblockId: ID!, name: String!, representations: BrandEssentialsColorBlockColorRepresentationsInput!
Optionaldescription: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createBrandEssentialsColor

Create a new brand essentials color.

Beta

Returns

CreateBrandEssentialsColor

Arguments

input:CreateBrandEssentialsColorInput!RequiredBeta
CreateBrandEssentialsColorInputType input argument.
RequiredcolorPaletteId: ID!, name: String!, representations: BrandEssentialsColorRepresentationsInput!
Optionaldescription: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

createBrandEssentialsColorPalette

Create a new brand essentials color palette.

Beta

Returns

CreateBrandEssentialsColorPalette

Arguments

input:CreateBrandEssentialsColorPaletteInput!RequiredBeta
CreateBrandEssentialsColorPaletteInputType input argument.
RequiredbrandId: ID!, name: String!
Optionaldescription: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

deleteBrandEssentialsColor

Delete a brand essentials color.

Beta

Returns

DeleteBrandEssentialsColor

Arguments

input:DeleteBrandEssentialsColorInput!RequiredBeta
DeleteBrandEssentialsColorInputType input argument.
RequiredcolorId: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

deleteBrandEssentialsColorPalette

Delete a brand essentials color palette.

Beta

Returns

DeleteBrandEssentialsColorPalette

Arguments

input:DeleteBrandEssentialsColorPaletteInput!RequiredBeta
DeleteBrandEssentialsColorPaletteInputType input argument.
RequiredpaletteId: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

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

InstallBrandEssentialsSelfhostedFontFormats

Arguments

input:InstallBrandEssentialsSelfhostedFontFormatsInput!RequiredBeta
InstallBrandEssentialsSelfhostedFontFormatsInput input argument.
RequiredbrandId: ID!, formats: [InstallBrandEssentialsSelfhostedFontFormatInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

moveBrandEssentialsColor

Move a brand essentials color to a different palette.

Beta

Returns

MoveBrandEssentialsColor

Arguments

input:MoveBrandEssentialsColorInput!RequiredBeta
MoveBrandEssentialsColorInputType input argument.
RequiredcolorId: ID!, colorPaletteId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

moveBrandEssentialsColorBlockColor

Moves a BrandEssentialsColorBlockColor within its BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

MoveBrandEssentialsColorBlockColor

Arguments

input:MoveBrandEssentialsColorBlockColorInput!RequiredBeta
RequiredcolorId: ID!
OptionalafterColorId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

removeBrandEssentialsColorBlockColorRepresentation

Removes a representation from a custom BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveBrandEssentialsColorBlockColorRepresentation

Arguments

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

removeBrandEssentialsColorBlockColors

Removes colors from a BrandEssentialsColorBlock. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveBrandEssentialsColorBlockColors

Arguments

input:RemoveBrandEssentialsColorBlockColorsInput!RequiredBeta
RequiredcolorIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

removeBrandEssentialsFontFamily

Remove a brand essentials font family.

Beta

Returns

RemoveBrandEssentialsFontFamily

Arguments

input:RemoveBrandEssentialsFontFamilyInput!RequiredBeta
RemoveBrandEssentialsFontFamilyInputType input argument.
RequiredfontFamilyId: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

  • ID!
Mutation

removeBrandEssentialsFontStyle

Remove a font style from a brand essentials font family.

Beta

Returns

RemoveBrandEssentialsFontStyle

Arguments

input:RemoveBrandEssentialsFontStyleInput!RequiredBeta
RemoveBrandEssentialsFontStyleInputType input argument.
RequiredfontFamilyId: ID!, weight: Int!, isItalic: Boolean!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

repositionBrandEssentialsColor

Reposition a brand essentials color within its palette.

Beta

Returns

RepositionBrandEssentialsColor

Arguments

input:RepositionBrandEssentialsColorInput!RequiredBeta
RepositionBrandEssentialsColorInputType input argument.
RequiredcolorId: ID!, newPosition: Int!

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateBrandEssentialsColor

Update a brand essentials color.

Beta

Returns

UpdateBrandEssentialsColor

Arguments

input:UpdateBrandEssentialsColorInput!RequiredBeta
UpdateBrandEssentialsColorInputType input argument.
RequiredcolorId: ID!
Optionalname: String, description: String, representations: UpdateBrandEssentialsColorRepresentationsInput

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

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

UpdateBrandEssentialsColorBlockColorDescription

Arguments

input:UpdateBrandEssentialsColorBlockColorDescriptionInput!RequiredBeta
RequiredcolorId: ID!, description: String!
Optionallocale: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

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

UpdateBrandEssentialsColorBlockColorName

Arguments

input:UpdateBrandEssentialsColorBlockColorNameInput!RequiredBeta
RequiredcolorId: ID!, name: String!
Optionallocale: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateBrandEssentialsColorBlockColorRepresentation

Adds or replaces a representation of a custom BrandEssentialsColorBlockColor. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

UpdateBrandEssentialsColorBlockColorRepresentation

Arguments

Response fields

0 selected

Toggle fields to tailor the query and response.

Mutation

updateBrandEssentialsColorPalette

Update a brand essentials color palette.

Beta

Returns

UpdateBrandEssentialsColorPalette

Arguments

input:UpdateBrandEssentialsColorPaletteInput!RequiredBeta
UpdateBrandEssentialsColorPaletteInputType input argument.
RequiredpaletteId: ID!
Optionalname: String, description: String, hiddenColorRepresentationKeys: [BrandEssentialsColorRepresentationKey!]

Response fields

0 selected

Toggle fields to tailor the query and response.