Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Path parameters
Name
Type
Required
Example
Description
locationId
string
Yes
ve9EPM428h8vShlRW1KT
Account ID where the brand board exists
id
string
Yes
507f1f77bcf86cd799439011
Brand board ID to update, retrieve, or delete
Responses
200 - Success
_id (string, required): Brand board ID Example: 507f1f77bcf86cd799439011
locationId (string, required): Account ID Example: ve9EPM428h8vShlRW1KT
name (string, required): Brand board name Example: My Brand Board
logos (object[]): Array of logos
id (string, required): Unique identifier for the logo Example: logo_abc123
url (string, required): Public URL of the logo image. Used for uploading to the brand board folder in media library Example: https://storage.googleapis.com/bucket/logos/my-logo.png
label (string, required): Display label for the logo (e.g., Primary, Secondary) Example: Primary Logo
path (string, required): Storage path of the logo in the media library Example: /locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png
colors (object[]): Array of brand colors
id (string, required): Unique identifier for the color Example: color_xyz789
hexa (string, required): Color in HEXA format (with alpha) Example: #FF5733FF
rgba (string, required): Color in RGBA format Example: rgba(255, 87, 51, 1)
hex (string, required): Color in HEX format Example: #FF5733
rgb (string, required): Color in RGB format Example: rgb(255, 87, 51)
label (string, required): Display label for the color Example: Brand Orange
fonts (object[]): Array of brand fonts
id (string, required): Unique identifier for the font Example: font_def456
font (string, required): Font family name Example: Montserrat
fallback (string, required): Fallback font family Example: sans-serif
label (string, required): Display label for the font Example: Heading Font
default (boolean, required): Whether this is the default brand board for the account Example: False
deleted (boolean, required): Whether the brand board has been soft deleted Example: False
parentId (string): Parent folder ID in media library Example: 507f1f77bcf86cd799439011
folderId (string): Media library folder ID for this brand board Example: 507f1f77bcf86cd799439011
originId (string): Original brand board ID if cloned from snapshot Example: 507f1f77bcf86cd799439011