HighLevel: Brand boards schemas

← Brand boards operations · All schemas

Create Brand Voice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
answers	JSON	Optional	Brand voice answers. Required when type is "manual"
answers (allOf 1)	Model	All variants apply	Expand Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition
description	string	Optional	Company description to generate brand voice from. Required when type is "description", optional when type is "url"
name	string	Optional	Name
type	string	Required within parent	Creation type. "manual" creates with provided custom answers, "url" generates answers from a website, "description" generates answers from a text description One of: manual, url, description
url	string	Optional	Website URL to generate brand voice from. Required when type is "url"

Referenced models: Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Field	Type	Presence	Description and constraints
$	object	Root
brandName	string	Required within parent	Brand Name
brandPromise	string	Optional	Brand Promise
brandPurpose	string	Optional	Brand Purpose
brandValues	string	Optional	Brand Values
businessHours	string	Optional	Business Hours
businessType	string	Optional	Business Type
callToAction	string	Optional	Call to Action
companyAddress	string	Optional	Company Address
companyEmail	string	Optional	Company Email
companyWebsite	string	Optional	Company Website
competitiveAdvantage	string	Optional	Competitive Advantage
customerPainPoints	string	Required within parent	Customer Pain Points
phone	object	Optional	Phone Information
risksOfInaction	string	Optional	Risks of Inaction
targetAudience	string	Required within parent	Target Audience
toneOfVoice	string	Required within parent	Tone of Voice
uniqueSellingProposition	string	Optional	Unique Selling Proposition

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

Delete Brand Voice — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Whether the brand voice is deleted
traceId	string	Optional	Trace ID of request

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 — 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

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 Boards — response body

Field	Type	Presence	Description and constraints
$	object	Root
brandBoards	array	Required within parent	Array of brand boards for the location
brandBoards[]	Model	Each item	Expand Get Brand Boards — response body — brand Boards item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	Total number of brand boards matching the query
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Brand Boards — response body — brand Boards item

Get Brand Boards — response body — brand Boards item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Brand board ID
default	boolean	Optional	Whether this is the default brand board for the location
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
name	string	Required within parent	Brand board name
updatedAt	string	Required within parent	Last update timestamp

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

Get Brand Voice — response body

Field	Type	Presence	Description and constraints
$	object	Root
answers	JSON	Optional	Brand voice answers
answers (allOf 1)	Model	All variants apply	Expand Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition
createdAt	string	Required within parent	Creation timestamp
deleted	boolean	Required within parent	Whether the brand voice has been soft deleted
id	string	Required within parent	Brand voice ID
isDefault	boolean	Required within parent	Whether this is the default brand voice
locationId	string	Required within parent	Location ID
name	string	Required within parent	Brand voice name
traceId	string	Optional	Trace ID of request
updatedAt	string	Required within parent	Last update timestamp

Referenced models: Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Field	Type	Presence	Description and constraints
$	object	Root
brandName	string	Optional	Brand Name
brandPromise	string	Optional	Brand Promise
brandPurpose	string	Optional	Brand Purpose
brandValues	string	Optional	Brand Values
businessHours	string	Optional	Business Hours
businessType	string	Optional	Business Type
callToAction	string	Optional	Call to Action
companyAddress	string	Optional	Company Address
companyEmail	string	Optional	Company Email
companyWebsite	string	Optional	Company Website
competitiveAdvantage	string	Optional	Competitive Advantage
customerPainPoints	string	Optional	Customer Pain Points
phone	object	Optional	Phone Information
risksOfInaction	string	Optional	Risks of Inaction
targetAudience	string	Optional	Target Audience
toneOfVoice	string	Optional	Tone of Voice
uniqueSellingProposition	string	Optional	Unique Selling Proposition

List Brand Voices — response body

Field	Type	Presence	Description and constraints
$	object	Root
items	array	Required within parent	List of brand voices
items[]	Model	Each item	Expand List Brand Voices — response body — items item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of brand voices
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of request

Referenced models: List Brand Voices — response body — items item

List Brand Voices — response body — items item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Creation timestamp
id	string	Required within parent	Brand voice ID
isDefault	boolean	Required within parent	Whether this is the default brand voice
name	string	Required within parent	Brand voice name
updatedAt	string	Required within parent	Last update timestamp

Set Default Brand Voice — response body

Field	Type	Presence	Description and constraints
$	object	Root
brandVoiceId	string	Required within parent	Brand voice ID that was set as default
success	boolean	Required within parent	Whether the operation was successful
traceId	string	Optional	Trace ID of request

Update Brand Voice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
answers	JSON	Optional	Updated answers
answers (allOf 1)	Model	All variants apply	Expand Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition
name	string	Optional	Name

Referenced models: Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Update a Brand Board — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
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
logos	array	Optional	Array of logos for the brand board
logos[]	Model	Each item	Expand Get Brand Board — response body — logos item
name	string	Optional	Name of the brand board
parentId	string	Optional	Parent folder ID in media library (reserved for future use)

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