Updates an existing Brand Board
PATCH https://services.leadconnectorhq.com/brand-boards/{locationId}/{id}Authorization
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | 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 |
Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
name | string | No | My Brandboard 2 | Name of the brand board |
logos(object[]): Array of logos for the brand boardid(string, required): Unique identifier for the logo Example:logo_abc123url(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.pnglabel(string, required): Display label for the logo (e.g., Primary, Secondary) Example:Primary Logopath(string, required): Storage path of the logo in the media library Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png
colors(object[]): Array of colors for the brand boardid(string, required): Unique identifier for the color Example:color_xyz789hexa(string, required): Color in HEXA format (with alpha) Example:#FF5733FFrgba(string, required): Color in RGBA format Example:rgba(255, 87, 51, 1)hex(string, required): Color in HEX format Example:#FF5733rgb(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 fonts for the brand boardid(string, required): Unique identifier for the font Example:font_def456font(string, required): Font family name Example:Montserratfallback(string, required): Fallback font family Example:sans-seriflabel(string, required): Display label for the font Example:Heading Font
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
default | boolean | No | True | Set as the default brand board for this account |
parentId | string | No | 507f1f77bcf86cd799439011 | Parent folder ID in media library (reserved for future use) |
Responses
200 - Success
_id(string, required): Brand board ID Example:507f1f77bcf86cd799439011locationId(string, required): Account ID Example:ve9EPM428h8vShlRW1KTname(string, required): Brand board name Example:My Brand Boardlogos(object[]): Array of logosid(string, required): Unique identifier for the logo Example:logo_abc123url(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.pnglabel(string, required): Display label for the logo (e.g., Primary, Secondary) Example:Primary Logopath(string, required): Storage path of the logo in the media library Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png
colors(object[]): Array of brand colorsid(string, required): Unique identifier for the color Example:color_xyz789hexa(string, required): Color in HEXA format (with alpha) Example:#FF5733FFrgba(string, required): Color in RGBA format Example:rgba(255, 87, 51, 1)hex(string, required): Color in HEX format Example:#FF5733rgb(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 fontsid(string, required): Unique identifier for the font Example:font_def456font(string, required): Font family name Example:Montserratfallback(string, required): Fallback font family Example:sans-seriflabel(string, required): Display label for the font Example:Heading Font
default(boolean, required): Whether this is the default brand board for the account Example:Falsedeleted(boolean, required): Whether the brand board has been soft deleted Example:FalseparentId(string): Parent folder ID in media library Example:507f1f77bcf86cd799439011folderId(string): Media library folder ID for this brand board Example:507f1f77bcf86cd799439011originId(string): Original brand board ID if cloned from snapshot Example:507f1f77bcf86cd799439011meta(object): Metadata about the brand boardcreatedAt(string): Creation timestamp Example:2024-01-05T12:00:00.000ZupdatedAt(string): Last update timestamp Example:2024-01-05T12:00:00.000Z
{
"_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"
}400 - Bad Request
{}403 - The token does not have access to this account
statusCode(number): Example:403message(string): Example:The token does not have access to this account
{
"statusCode": 403,
"message": "The token does not have access to this account"
}404 - Not Found
statusCode(number): Example:404message(string): Example:Not Founderror(string): Example:The requested resource was not found
{
"statusCode": 404,
"message": "Not Found",
"error": "The requested resource was not found"
}422 - Unprocessable Entity
{}Example
curl -X PATCH 'https://services.leadconnectorhq.com/brand-boards/YOUR_locationId/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "My Brandboard 2",
"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,
"parentId": "507f1f77bcf86cd799439011"
}'const response = await fetch('https://services.leadconnectorhq.com/brand-boards/YOUR_locationId/YOUR_id', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "My Brandboard 2", "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, "parentId": "507f1f77bcf86cd799439011"}),
});
const data = await response.json();import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/brand-boards/YOUR_locationId/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "My Brandboard 2", "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, "parentId": "507f1f77bcf86cd799439011"},
)
data = response.json()<?php
$ch = curl_init('https://services.leadconnectorhq.com/brand-boards/YOUR_locationId/YOUR_id');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'My Brandboard 2', '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, 'parentId': '507f1f77bcf86cd799439011'}),
]);
$data = json_decode(curl_exec($ch), true);