Update a Brand Board

Updates an existing Brand Board

PATCH https://services.leadconnectorhq.com/brand-boards/{locationId}/{id}

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Path parameters

string

default:"ve9EPM428h8vShlRW1KT"

required

Account ID where the brand board exists

string

default:"507f1f77bcf86cd799439011"

required

Brand board ID to update, retrieve, or delete

Body

string

default:"My Brandboard 2"

Name of the brand board

object[]

Array of logos for the brand board

Show cada item

string

default:"logo_abc123"

required

Unique identifier for the logo

string

required

Public URL of the logo image. Used for uploading to the brand board folder in media library

string

default:"Primary Logo"

required

Display label for the logo (e.g., Primary, Secondary)

string

required

Storage path of the logo in the media library

object[]

Array of colors for the brand board

Show cada item

string

default:"color_xyz789"

required

Unique identifier for the color

string

default:"#FF5733FF"

required

Color in HEXA format (with alpha)

string

default:"rgba(255, 87, 51, 1)"

required

Color in RGBA format

string

default:"#FF5733"

required

Color in HEX format

string

default:"rgb(255, 87, 51)"

required

Color in RGB format

string

default:"Brand Orange"

required

Display label for the color

object[]

Array of fonts for the brand board

Show cada item

string

default:"font_def456"

required

Unique identifier for the font

string

default:"Montserrat"

required

Font family name

string

default:"sans-serif"

required

Fallback font family

string

default:"Heading Font"

required

Display label for the font

boolean

default:"True"

Set as the default brand board for this account

string

default:"507f1f77bcf86cd799439011"

Parent folder ID in media library (reserved for future use)

Respuestas

200 - Success

string

default:"507f1f77bcf86cd799439011"

required

Brand board ID

string

default:"ve9EPM428h8vShlRW1KT"

required

Account ID

string

default:"My Brand Board"

required

Brand board name

object[]

Array of logos

Show cada item

string

default:"logo_abc123"

required

Unique identifier for the logo

string

required

Public URL of the logo image. Used for uploading to the brand board folder in media library

string

default:"Primary Logo"

required

Display label for the logo (e.g., Primary, Secondary)

string

required

Storage path of the logo in the media library

object[]

Array of brand colors

Show cada item

string

default:"color_xyz789"

required

Unique identifier for the color

string

default:"#FF5733FF"

required

Color in HEXA format (with alpha)

string

default:"rgba(255, 87, 51, 1)"

required

Color in RGBA format

string

default:"#FF5733"

required

Color in HEX format

string

default:"rgb(255, 87, 51)"

required

Color in RGB format

string

default:"Brand Orange"

required

Display label for the color

object[]

Array of brand fonts

Show cada item

string

default:"font_def456"

required

Unique identifier for the font

string

default:"Montserrat"

required

Font family name

string

default:"sans-serif"

required

Fallback font family

string

default:"Heading Font"

required

Display label for the font

boolean

default:"False"

required

Whether this is the default brand board for the account

boolean

default:"False"

required

Whether the brand board has been soft deleted

string

default:"507f1f77bcf86cd799439011"

Parent folder ID in media library

string

default:"507f1f77bcf86cd799439011"

Media library folder ID for this brand board

string

default:"507f1f77bcf86cd799439011"

Original brand board ID if cloned from snapshot

object

Metadata about the brand board

string

default:"2024-01-05T12:00:00.000Z"

Creation timestamp

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"
}

400 - Bad Request

{}

401 - Unauthorized

{}

403 - The token does not have access to this account

number

default:"403"

string

default:"The token does not have access to this account"

{
  "statusCode": 403,
  "message": "The token does not have access to this account"
}

404 - Not Found

number

default:"404"

string

default:"Not Found"

string

default:"The requested resource was not found"

{
  "statusCode": 404,
  "message": "Not Found",
  "error": "The requested resource was not found"
}

422 - Unprocessable Entity

{}

Ejemplo

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);

Empezar

Scopes

Autorización

Path parameters

Body

Respuestas

Ejemplo

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo