Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Creates a new brand board with logos, colors, and fonts
POST https://services.leadconnectorhq.com/brand-boards/
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Body
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account ID where the brand board will be created
name
string
default:"My Brand Board"
required
Name of the brand board
Array of logos for the brand board
id
string
default:"logo_abc123"
required
Unique identifier for the logo
Public URL of the logo image. Used for uploading to the brand board folder in media library
label
string
default:"Primary Logo"
required
Display label for the logo (e.g., Primary, Secondary)
Storage path of the logo in the media library
Array of colors for the brand board
id
string
default:"color_xyz789"
required
Unique identifier for the color
hexa
string
default:"#FF5733FF"
required
Color in HEXA format (with alpha)
rgba
string
default:"rgba(255, 87, 51, 1)"
required
Color in RGBA format
hex
string
default:"#FF5733"
required
Color in HEX format
rgb
string
default:"rgb(255, 87, 51)"
required
Color in RGB format
label
string
default:"Brand Orange"
required
Display label for the color
Array of fonts for the brand board
id
string
default:"font_def456"
required
Unique identifier for the font
font
string
default:"Montserrat"
required
Font family name
fallback
string
default:"sans-serif"
required
Fallback font family
label
string
default:"Heading Font"
required
Display label for the font
Set as the default brand board for this account
brandBoardId
string
default:"507f1f77bcf86cd799439011"
Source brand board ID to copy from (creates a new brand board based on this template)
parentId
string
default:"507f1f77bcf86cd799439011"
Parent folder ID in media library for organizing brand boards
Source type indicating how the brand board was created Posibles valores: ‘template’, ‘blank’, ‘snapshot’
Respuestas
_id
string
default:"507f1f77bcf86cd799439011"
required
Brand board ID
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account ID
name
string
default:"My Brand Board"
required
Brand board name
Array of logos
id
string
default:"logo_abc123"
required
Unique identifier for the logo
Public URL of the logo image. Used for uploading to the brand board folder in media library
label
string
default:"Primary Logo"
required
Display label for the logo (e.g., Primary, Secondary)
Storage path of the logo in the media library
Array of brand colors
id
string
default:"color_xyz789"
required
Unique identifier for the color
hexa
string
default:"#FF5733FF"
required
Color in HEXA format (with alpha)
rgba
string
default:"rgba(255, 87, 51, 1)"
required
Color in RGBA format
hex
string
default:"#FF5733"
required
Color in HEX format
rgb
string
default:"rgb(255, 87, 51)"
required
Color in RGB format
label
string
default:"Brand Orange"
required
Display label for the color
Array of brand fonts
id
string
default:"font_def456"
required
Unique identifier for the font
font
string
default:"Montserrat"
required
Font family name
fallback
string
default:"sans-serif"
required
Fallback font family
label
string
default:"Heading Font"
required
Display label for the font
default
boolean
default:"False"
required
Whether this is the default brand board for the account
deleted
boolean
default:"False"
required
Whether the brand board has been soft deleted
parentId
string
default:"507f1f77bcf86cd799439011"
Parent folder ID in media library
folderId
string
default:"507f1f77bcf86cd799439011"
Media library folder ID for this brand board
originId
string
default:"507f1f77bcf86cd799439011"
Original brand board ID if cloned from snapshot
Metadata about the brand board
createdAt
string
default:"2024-01-05T12:00:00.000Z"
Creation timestamp
updatedAt
string
default:"2024-01-05T12:00:00.000Z"
Last update timestamp
{
"_id": "507f1f77bcf86cd799439011",
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "My Brand Board",
"logos": [
{
"id": "logo_abc123",
"url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
"label": "Primary Logo",
"path": "/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png"
}
],
"colors": [
{
"id": "color_xyz789",
"hexa": "#FF5733FF",
"rgba": "rgba(255, 87, 51, 1)",
"hex": "#FF5733",
"rgb": "rgb(255, 87, 51)",
"label": "Brand Orange"
}
],
"fonts": [
{
"id": "font_def456",
"font": "Montserrat",
"fallback": "sans-serif",
"label": "Heading Font"
}
],
"default": false,
"deleted": false,
"parentId": "507f1f77bcf86cd799439011",
"folderId": "507f1f77bcf86cd799439011",
"originId": "507f1f77bcf86cd799439011",
"createdAt": "2024-01-05T12:00:00.000Z",
"updatedAt": "2024-01-05T12:00:00.000Z"
}
403 - The token does not have access to this account
message
string
default:"The token does not have access to this account"
{
"statusCode": 403,
"message": "The token does not have access to this account"
}
422 - Unprocessable Entity
Ejemplo
curl -X POST 'https://services.leadconnectorhq.com/brand-boards/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "My Brand Board",
"logos": [
{
"id": "logo_abc123",
"url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
"label": "Primary Logo",
"path": "/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png"
}
],
"colors": [
{
"id": "color_xyz789",
"hexa": "#FF5733FF",
"rgba": "rgba(255, 87, 51, 1)",
"hex": "#FF5733",
"rgb": "rgb(255, 87, 51)",
"label": "Brand Orange"
}
],
"fonts": [
{
"id": "font_def456",
"font": "Montserrat",
"fallback": "sans-serif",
"label": "Heading Font"
}
],
"default": true,
"brandBoardId": "507f1f77bcf86cd799439011",
"parentId": "507f1f77bcf86cd799439011",
"type": "blank"
}'
