Create Design Kit

POST 
/brand-boards/locations/:locationId/design-kits

Create a design kit for a location

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

ID of the location where the design kit will be created.

application/json

application/json

Body

Bodyrequired

namestring

Display name for the design kit.

logosobject[]

Logos to include in the design kit.

colorsobject[]

Colors to include in the design kit.

fontsobject[]

Fonts to include in the design kit.

typestring
How the design kit should be initialized. Use blank for an empty kit, or url to extract branding from a website (requires url).
Available optionsblankurl
urlstring

Website URL to extract branding from. Required when type is url.

Example (auto)

{
  "name": "My Design Kit",
  "logos": [
    {
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo"
    }
  ],
  "colors": [
    {
      "value": "#FF5733",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "type": "blank",
  "url": "https://example.com"
}

application/json

Created

application/json

Schema

Schema

idstringrequired

Unique identifier of the design kit.

namestringrequired

Display name of the design kit.

isDefaultbooleanrequired

Whether this is the default design kit for the location.

createdAtstringrequired

ISO 8601 timestamp of when the design kit was created.

updatedAtstringrequired

ISO 8601 timestamp of when the design kit was last updated.

locationIdstringrequired

ID of the location that owns the design kit.

deletedbooleanrequired

Whether the design kit has been soft-deleted.

logosobject[]

Logos belonging to the design kit.

colorsobject[]

Colors belonging to the design kit.

fontsobject[]

Fonts belonging to the design kit.

traceIdstring

Trace identifier for the request, useful for debugging and support.

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "name": "My Design Kit",
  "isDefault": false,
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z",
  "locationId": "oHJiAh0wDG3BzmzACVD6",
  "deleted": false,
  "logos": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3c9",
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo"
    }
  ],
  "colors": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3ca",
      "hex": "#FF5733",
      "hexa": "#FF5733FF",
      "rgb": "rgb(255, 87, 51)",
      "rgba": "rgba(255, 87, 51, 1)",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3cb",
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}