Brands

Query

brand

Open full page ↗Raw SDL

Retrieve a Brand by its Id.

Returns

Brand

Arguments

id:ID!Required: Brand Id.

Response fields

1 selected

Toggle fields to tailor the query and response.

avatarUrl
creativeTemplatesCreativeTemplateItems!
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[CreativeTemplate]!
  - nameString!
  - idID!
  - descriptionString
  - modeCreativeTemplateMode
  - exportOptions[CreativeTemplateExportOption!]!
    - formatCreativeExportFormat
  - pages[CreativeTemplatePage!]!
    - previewUrlUrl!
customMetadataProperties[CustomMetadataProperty!]!
- nameString!
- idID!
- createdAtDateTime!
- defaultValueAny
- forbiddenDependeePropertyIds[ID!]
- helpTextString
- creatorUser!
  - nameString
  - idID!
- dependencyCustomMetadataPropertyDependency
  - propertyIdID!
  - typeString!
  - … on CustomMetadataPropertySelectValueTypeDependencyTypeEquals
    - propertyOptionIdID!
  - … on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf
    - propertyOptionIds[ID]!
- modifierUser
  - nameString
  - idID!
- permissionsCustomMetadataPropertyPermissions
  - basic[CustomMetadataPropertyBasicPermission]
    - permissionLevelCustomMetadataPropertyPermissionLevel!
  - custom[CustomMetadataPropertyCustomPermission]
    - permissionLevelCustomMetadataPropertyPermissionLevel!
- typeCustomMetadataPropertyType!
  - nameString!
  - … on CustomMetadataPropertyTypeCatalog
    - allowedLinkedColumnIds[ID!]!
    - allowMultiSelectBoolean!
enhancedSearchBrandEnhancedSearchItems
- hasNextPageBoolean!
- limitInt!
- pageInt!
- edges[BrandSearchResultEdge]
  - titleString!
  - nodeBrandSearchResult
    - … on Audio
      - idID!
    - … on Document
      - idID!
    - … on EmbeddedContent
      - idID!
    - … on File
      - idID!
    - … on Image
      - idID!
    - … on Video
      - idID!
- items[BrandSearchResult]
  - … on Audio
    - idID!
  - … on Document
    - idID!
  - … on EmbeddedContent
    - idID!
  - … on File
    - idID!
  - … on Image
    - idID!
  - … on Video
    - idID!
essentialsBrandEssentials!
- colorPalettesBrandEssentialsColorPaletteItems!
  - totalInt!
  - pageInt!
  - limitInt!
  - hasNextPageBoolean!
  - items[BrandEssentialsColorPalette!]!
    - idID!
- fontFamiliesBrandEssentialsFontFamilyItems!
  - totalInt!
  - pageInt!
  - limitInt!
  - hasNextPageBoolean!
  - items[BrandEssentialsFontFamily!]!
    - idID!
guidelinesGuidelineItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[Guideline]
  - nameString
  - idID!
  - urlUrl!
  - availableBlockTypes[GuidelinePageBlockType!]!
    - idID!
  - colorRgbaColor
    - alphaPercent!
idID!
librariesLibraryItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[Library]
  - nameString!
  - idID!
  - assetsAssetItems!
    - totalInt!
    - pageInt!
    - limitInt!
    - hasNextPageBoolean!
    - items[Asset]
      - idID!
  - browseLibraryRootFolder!
nameString!
rgbaColorRgbaColor
- alphaPercent!
- blueRgbColorChannel!
- greenRgbColorChannel!
- redRgbColorChannel!
searchBrandSearchItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[BrandSearchResult]
  - … on Audio
    - idID!
  - … on Document
    - idID!
  - … on EmbeddedContent
    - idID!
  - … on File
    - idID!
  - … on Image
    - idID!
  - … on Video
    - idID!
slugString
workspaceProjectsWorkspaceItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[Workspace]
  - nameString!
  - idID!
  - isArchivedBoolean!
  - assetsAssetItems!
    - totalInt!
    - pageInt!
    - limitInt!
    - hasNextPageBoolean!
    - items[Asset]
      - idID!
  - browseWorkspaceRootFolder!

Example

query Brand {
  brand(
    id: 
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "brand": {
      "__typename": "Brand",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Query

Open full page ↗Raw SDL

Retrieve Brand list for current Account.

Returns

[Brand]

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

query Brands {
  brands {
    __typename
    id
  }
}

Example response

{
  "data": {
    "brands": [
      {
        "__typename": "Brand",
        "id": "eyJXXXXXXXX…"
      }
    ]
  }
}

Mutation

createBrand

Open full page ↗Raw SDL

Create a new Brand. Requires basic:write scope to be accessible and Account permission level EDIT.

Beta

Returns

CreateBrand

Arguments

input:CreateBrandInput!Required: CreateBrand input argument.; Requiredname: String!; Optionalcolor: RgbaColorInput

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateBrand {
  createBrand(
    input: {
      name: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createBrand": {
      "__typename": "CreateBrand"
    }
  }
}

Mutation

deleteBrand

Open full page ↗Raw SDL

Delete an existing Brand. Requires basic:write scope to be accessible and Brand permission level EDIT.

Beta

Returns

DeleteBrand

Arguments

input:DeleteBrandInput!Required: DeleteBrand input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteBrand {
  deleteBrand(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteBrand": {
      "__typename": "DeleteBrand",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

updateBrand

Open full page ↗Raw SDL

Update an existing Brand. Requires basic:write scope to be accessible and Brand permission level EDIT.

Beta

Returns

UpdateBrand

Arguments

input:UpdateBrandInput!Required: UpdateBrand input argument.; Requiredid: ID!, data: UpdateBrandDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateBrand {
  updateBrand(
    input: {
      id: 
      data: {
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateBrand": {
      "__typename": "UpdateBrand"
    }
  }
}