HighLevel: Create a new brand board

← Brand boards operations · Get started

Operation gohighlevel.createbrandboard

Provider route: POST /brand-boards/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["brandBoards"]["createBrandBoard"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.brandBoards.createBrandBoard(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.brand_boards.create_brand_board(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create a new brand board — request body — body

Referenced models: Create a new brand board — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Brand Board — response body

Referenced models: Get Brand Board — response body

Schemas

Create a new brand board — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
brandBoardId	string	Optional	Source brand board ID to copy from (creates a new brand board based on this template)
colors	array	Optional	Array of colors for the brand board
colors[]	Model	Each item	Expand Get Brand Board — response body — colors item
default	boolean	Optional	Set as the default brand board for this location
fonts	array	Optional	Array of fonts for the brand board
fonts[]	Model	Each item	Expand Get Brand Board — response body — fonts item
locationId	string	Required within parent	Location ID where the brand board will be created
logos	array	Optional	Array of logos for the brand board
logos[]	Model	Each item	Expand Get Brand Board — response body — logos item
name	string	Required within parent	Name of the brand board
parentId	string	Optional	Parent folder ID in media library for organizing brand boards
type	string	Optional	Source type indicating how the brand board was created One of: template, blank, snapshot, url
url	string	Optional	Website URL to extract design kit from (colors, fonts, logos)

Referenced models: Get Brand Board — response body — colors item, Get Brand Board — response body — fonts item, Get Brand Board — response body — logos item

Get Brand Board — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Brand board ID
colors	array	Optional	Array of brand colors
colors[]	Model	Each item	Expand Get Brand Board — response body — colors item
createdAt	string	Optional	Creation timestamp
default	boolean	Required within parent	Whether this is the default brand board for the location
deleted	boolean	Required within parent	Whether the brand board has been soft deleted
folderId	string	Optional	Media library folder ID for this brand board
fonts	array	Optional	Array of brand fonts
fonts[]	Model	Each item	Expand Get Brand Board — response body — fonts item
locationId	string	Required within parent	Location ID
logos	array	Optional	Array of logos
logos[]	Model	Each item	Expand Get Brand Board — response body — logos item
meta	JSON	Optional	Metadata about the brand board
meta (allOf 1)	Model	All variants apply	Expand Get Brand Board — response body — meta / sourceType: template, blank, snapshot, url
missingAssets	JSON	Optional	Assets that used fallbacks/defaults (only returned when creating from URL)
missingAssets (allOf 1)	Model	All variants apply	Expand Get Brand Board — response body — missing Assets colors, fonts, logos
name	string	Required within parent	Brand board name
originId	string	Optional	Original brand board ID if cloned from snapshot
parentId	string	Optional	Parent folder ID in media library
updatedAt	string	Optional	Last update timestamp

Referenced models: Get Brand Board — response body — colors item, Get Brand Board — response body — fonts item, Get Brand Board — response body — logos item, Get Brand Board — response body — missing Assets colors, fonts, logos, Get Brand Board — response body — meta / sourceType: template, blank, snapshot, url

Get Brand Board — response body — colors item

Field	Type	Presence	Description and constraints
$	object	Root
hex	string	Required within parent	Color in HEX format
hexa	string	Required within parent	Color in 8-digit hexadecimal notation with alpha channel
id	string	Optional	Unique identifier for the color
label	string	Required within parent	Display label for the color
rgb	string	Required within parent	Color in RGB format
rgba	string	Required within parent	Color with red, green, blue, and alpha channel values

Get Brand Board — response body — fonts item

Field	Type	Presence	Description and constraints
$	object	Root
fallback	string	Required within parent	Fallback font family
font	string	Required within parent	Font family name
id	string	Optional	Unique identifier for the font
label	string	Required within parent	Display label for the font

Get Brand Board — response body — logos item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Unique identifier for the logo
label	string	Required within parent	Display label for the logo (e.g., Primary, Secondary)
path	string	Required within parent	Storage path of the logo in the media library
url	string	Required within parent	Public URL of the logo image. Used for uploading to the brand board folder in media library

Get Brand Board — response body — missing Assets colors, fonts, logos

Field	Type	Presence	Description and constraints
$	object	Root
colors	array	Required within parent	Color labels that used defaults
colors[]	string	Each item
fonts	array	Required within parent	Font labels that used defaults
fonts[]	string	Each item
logos	array	Required within parent	Logo labels that used fallbacks
logos[]	string	Each item

Get Brand Board — response body — meta / sourceType: template, blank, snapshot, url

Field	Type	Presence	Description and constraints
$	object	Root
lastAction	string	Optional	Last action performed on the brand board
sourceId	string	Optional	Source brand board ID if created from a template
sourceType	string	Optional	How the brand board was created Known values: template, blank, snapshot, url
updatedBy	string	Optional	User ID who last updated the brand board

Policy, approvals and errors

SDK function policy ID: gohighlevel.createbrandboard. Catalog operation: createBrandBoard. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["brand-boards/design-kit.write"]

Pinned headers: {"Version": "v3"}

Official provider source