Design Kits API – Brand Boards API v3
The Design Kits API enables marketplace developers to create, read, update, and delete design kits for a location via REST endpoints. Design kits contain brand design data including colors, fonts, and other visual elements that power Brand Boards inside HighLevel.
You can find the Design Kits APIs here.
This article covers the six available endpoints, authentication requirements, and how the Design Kits API integrates with the broader Brand Boards API v3 suite.
What is the Design Kits API?
The Design Kits API is a public REST API within the Brand Boards API v3 suite that allows marketplace developers to programmatically manage design kits for HighLevel locations. Design kits store brand design data such as colors, fonts, and other visual elements that are used throughout the HighLevel platform, particularly in Brand Boards and page building.
This API provides the same access to design kit data that users have through the Brand Boards interface inside the HighLevel application. Developers can create, retrieve, update, delete, and set default design kits for any location using standard REST operations.
The Design Kits API complements the Brand Voices v3 endpoints, which were released earlier under the same Brand Boards API v3 surface, providing comprehensive programmatic control over a location's brand assets.
Key Benefits
The Design Kits API provides several advantages for marketplace developers and integration partners:
Available Endpoints
The Design Kits API provides six REST endpoints under the base path /brand-boards/locations/:locationId/design-kits. All endpoints require a valid location ID in the path parameter.
Retrieves all design kits associated with the specified location. Returns an array of design kit objects containing brand design data including colors, fonts, and other visual settings.
Creates a new design kit for the specified location. Accepts design kit configuration data in the request body and returns the created design kit object with a unique identifier.
Retrieves a specific design kit using its unique identifier. Returns the complete design kit object including all brand design properties.
Updates an existing design kit with partial data. Only the properties included in the request body are modified. Returns the updated design kit object.
Permanently removes a design kit from the location. This operation cannot be undone. Returns a confirmation response upon successful deletion.
Designates a specific design kit as the default for the location. Automatically unsets any previous default design kit. The default design kit is applied automatically when creating new branded assets.
Authentication and Authorization
The Design Kits API uses standard OAuth 2.0 authentication, consistent with other HighLevel marketplace APIs. Developers must obtain a valid access token through the OAuth 2.0 authorization flow before making API requests.
All API requests must include the access token in the Authorization header using the Bearer token scheme. The token must have the appropriate scopes to access Brand Boards resources for the target location.
For detailed information on implementing OAuth 2.0 authentication with HighLevel's marketplace APIs, refer to the authentication documentation in the HighLevel developer portal.
Related Articles
Frequently Asked Questions
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article