Skip to main content
Design KitsVersion: v3New

Create Design Kit

POST/brand-boards/locations/{locationId}/design-kits

Create a design kit for a location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:brand-boards/design-kit.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

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

Example:oHJiAh0wDG3BzmzACVD6

Body

application/json
namestring

Display name for the design kit.

Example:My 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
Example:blank
urlstring

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

Example:https://example.com

Response

application/json

Created

idstringrequired

Unique identifier of the design kit.

Example:507f1f77bcf86cd799439011
namestringrequired

Display name of the design kit.

Example:My Design Kit
isDefaultbooleanrequired

Whether this is the default design kit for the location.

Example:false
createdAtstringrequired

ISO 8601 timestamp of when the design kit was created.

Example:2024-01-05T12:00:00.000Z
updatedAtstringrequired

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

Example:2024-01-05T12:00:00.000Z
locationIdstringrequired

ID of the location that owns the design kit.

Example:oHJiAh0wDG3BzmzACVD6
deletedbooleanrequired

Whether the design kit has been soft-deleted.

Example:false
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:019e4ef5-a65e-4198-8cf9-8e93dca9bda4