Create a new brand board

POST 
/brand-boards/

Creates a new brand board with logos, colors, and fonts

Request

Version stringrequired

API Version

Available options2023-02-21

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID where the brand board will be created

namestringrequired

Name of the brand board

logosobject[]

Array of logos for the brand board

colorsobject[]

Array of colors for the brand board

fontsobject[]

Array of fonts for the brand board

defaultboolean

Set as the default brand board for this location

brandBoardIdstring

Source brand board ID to copy from (creates a new brand board based on this template)

parentIdstring

Parent folder ID in media library for organizing brand boards

typestring
Source type indicating how the brand board was created
Available optionstemplateblanksnapshoturl
urlstring

Website URL to extract design kit from (colors, fonts, logos)

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "My Brand Board",
  "logos": [
    {
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo",
      "path": "/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png"
    }
  ],
  "colors": [
    {
      "hexa": "#FF5733FF",
      "rgba": "rgba(255, 87, 51, 1)",
      "hex": "#FF5733",
      "rgb": "rgb(255, 87, 51)",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "default": true,
  "brandBoardId": "507f1f77bcf86cd799439011",
  "parentId": "507f1f77bcf86cd799439011",
  "type": "blank",
  "url": "https://example.com"
}

application/json

Created

application/json

Schema

Schema

_idstringrequired

Brand board ID

locationIdstringrequired

Location ID

namestringrequired

Brand board name

logosobject[]

Array of logos

colorsobject[]

Array of brand colors

fontsobject[]

Array of brand fonts

defaultbooleanrequired

Whether this is the default brand board for the location

deletedbooleanrequired

Whether the brand board has been soft deleted

parentIdstring

Parent folder ID in media library

folderIdstring

Media library folder ID for this brand board

originIdstring

Original brand board ID if cloned from snapshot

metaobject

Metadata about the brand board

missingAssetsobject

Assets that used fallbacks/defaults (only returned when creating from URL)

createdAtstring

Creation timestamp

updatedAtstring

Last update timestamp

Example (auto)

{
  "_id": "507f1f77bcf86cd799439011",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "My Brand Board",
  "logos": [
    {
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo",
      "path": "/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png"
    }
  ],
  "colors": [
    {
      "hexa": "#FF5733FF",
      "rgba": "rgba(255, 87, 51, 1)",
      "hex": "#FF5733",
      "rgb": "rgb(255, 87, 51)",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "default": false,
  "deleted": false,
  "parentId": "507f1f77bcf86cd799439011",
  "folderId": "507f1f77bcf86cd799439011",
  "originId": "507f1f77bcf86cd799439011",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "missingAssets": {
    "logos": [
      "Footer"
    ],
    "fonts": [
      "Arial"
    ],
    "colors": []
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}