Skip to content

Brand-Boards.md

Latest commit

 

History

History
2840 lines (2024 loc) · 44.5 KB

Brand-Boards.md

File metadata and controls

2840 lines (2024 loc) · 44.5 KB

Brand Boards API

Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25

Table of Contents

Brand Boards

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/brand-boards

Skip to main content

Documentation for Brand Boards API

📄️ Get Brand Boards \ Retrieves all Brand Boards for a specific location📄️ Get Brand Board \ Retrieves a specific Brand Board by its ID📄️ Update a Brand Board \ Updates an existing Brand Board📄️ Delete a Brand Board \ Deletes a Brand Board📄️ Create a new brand board \ Creates a new brand board with logos, colors, and fonts

Brand Boards Api

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/brand-boards-api

Skip to main content

Version: 1.0

Brand Boards API

Documentation for Brand Boards API

Authentication ​

  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Agency.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Create Brand Board

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/create-brand-board

Skip to main content

Create a new brand board

POST https://services.leadconnectorhq.com/brand-boards/

Creates a new brand board with logos, colors, and fonts

Requirements

Scope(s)

brand-boards/design-kit.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

  • application/json

Body required

locationId stringrequired

Location ID where the brand board will be created

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Name of the brand board

Example:My Brand Board

logos object[]

Array of logos for the brand board

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of colors for the brand board

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of fonts for the brand board

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default boolean

Set as the default brand board for this location

Example:true

brandBoardId string

Source brand board ID to copy from (creates a new brand board based on this template)

Example:507f1f77bcf86cd799439011

parentId string

Parent folder ID in media library for organizing brand boards

Example:507f1f77bcf86cd799439011

type string

Source type indicating how the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

Responses ​

  • 201
  • 400
  • 401
  • 403
  • 422

Created

  • application/json

  • Schema

  • Example (auto)

Schema

_id stringrequired

Brand board ID

Example:507f1f77bcf86cd799439011

locationId stringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Brand board name

Example:My Brand Board

logos object[]

Array of logos

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of brand colors

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of brand fonts

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default booleanrequired

Whether this is the default brand board for the location

Example:false

deleted booleanrequired

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

meta object

Metadata about the brand board

updatedBy string

User ID who last updated the brand board

Example:user_abc123

lastAction string

Last action performed on the brand board

Example:UPDATE

sourceId string

Source brand board ID if created from a template

Example:507f1f77bcf86cd799439011

sourceType string

How the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

createdAt string

Creation timestamp

Example:2024-01-05T12:00:00.000Z

updatedAt 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",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

The token does not have access to this location

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:403

message string

Example:The token does not have access to this location

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

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: brand-boards/design-kit.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/brand-boards/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-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"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

Version — headerrequired

---2021-07-28

Body required

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

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Delete Brand Board

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/delete-brand-board

Skip to main content

Delete a Brand Board

DELETE https://services.leadconnectorhq.com/brand-boards/:locationId/:id

Deletes a Brand Board

Requirements

Scope(s)

brand-boards/design-kit.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

locationId stringrequired

Location ID where the brand board exists

Example: ve9EPM428h8vShlRW1KT

id stringrequired

Brand board ID to update, retrieve, or delete

Example: 507f1f77bcf86cd799439011

Responses ​

  • 200
  • 400
  • 401
  • 403
  • 404
  • 422

Success

  • application/json

  • Schema

  • Example (auto)

Schema

_id stringrequired

Brand board ID

Example:507f1f77bcf86cd799439011

locationId stringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Brand board name

Example:My Brand Board

logos object[]

Array of logos

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of brand colors

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of brand fonts

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default booleanrequired

Whether this is the default brand board for the location

Example:false

deleted booleanrequired

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

meta object

Metadata about the brand board

updatedBy string

User ID who last updated the brand board

Example:user_abc123

lastAction string

Last action performed on the brand board

Example:UPDATE

sourceId string

Source brand board ID if created from a template

Example:507f1f77bcf86cd799439011

sourceType string

How the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

createdAt string

Creation timestamp

Example:2024-01-05T12:00:00.000Z

updatedAt 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",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

The token does not have access to this location

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:403

message string

Example:The token does not have access to this location

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

Not Found

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:404

message string

Example:Not Found

error string

Example:The requested resource was not found

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

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: brand-boards/design-kit.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X DELETE 'https://services.leadconnectorhq.com/brand-boards/:locationId/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Brand Board By Id

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/get-brand-board-by-id

Skip to main content

Get Brand Board

GET https://services.leadconnectorhq.com/brand-boards/:locationId/:id

Retrieves a specific Brand Board by its ID

Requirements

Scope(s)

brand-boards/design-kit.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

locationId stringrequired

Location ID where the brand board exists

Example: ve9EPM428h8vShlRW1KT

id stringrequired

Brand board ID to update, retrieve, or delete

Example: 507f1f77bcf86cd799439011

Responses ​

  • 200
  • 400
  • 401
  • 403
  • 404
  • 422

Success

  • application/json

  • Schema

  • Example (auto)

Schema

_id stringrequired

Brand board ID

Example:507f1f77bcf86cd799439011

locationId stringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Brand board name

Example:My Brand Board

logos object[]

Array of logos

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of brand colors

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of brand fonts

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default booleanrequired

Whether this is the default brand board for the location

Example:false

deleted booleanrequired

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

meta object

Metadata about the brand board

updatedBy string

User ID who last updated the brand board

Example:user_abc123

lastAction string

Last action performed on the brand board

Example:UPDATE

sourceId string

Source brand board ID if created from a template

Example:507f1f77bcf86cd799439011

sourceType string

How the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

createdAt string

Creation timestamp

Example:2024-01-05T12:00:00.000Z

updatedAt 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",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

The token does not have access to this location

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:403

message string

Example:The token does not have access to this location

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

Not Found

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:404

message string

Example:Not Found

error string

Example:The requested resource was not found

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

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: brand-boards/design-kit.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/brand-boards/:locationId/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Brand Boards By Location

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/get-brand-boards-by-location

Skip to main content

Get Brand Boards

GET https://services.leadconnectorhq.com/brand-boards/:locationId

Retrieves all Brand Boards for a specific location

Requirements

Scope(s)

brand-boards/design-kit.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

locationId stringrequired

Query Parameters

limit number

Maximum number of brand boards to return

Default value:10

Example: 10

offset number

Number of brand boards to skip for pagination

Default value:0

Example: 0

search string

Search term to filter brand boards by name

Default value:``

Example: brandboard

deleted boolean

Include deleted brand boards in results

Default value:false

Responses ​

  • 200
  • 400
  • 401
  • 403
  • 422

Success

  • application/json

  • Schema

  • Example (auto)

Schema

brandBoards object[]required

Array of brand boards for the location

Array [

_id stringrequired

Brand board ID

Example:507f1f77bcf86cd799439011

name stringrequired

Brand board name

Example:My Brand Board

updatedAt stringrequired

Last update timestamp

Example:2024-01-05T12:00:00.000Z

default boolean

Whether this is the default brand board for the location

Example:false

meta object

Metadata about the brand board

updatedBy string

User ID who last updated the brand board

Example:user_abc123

lastAction string

Last action performed on the brand board

Example:UPDATE

sourceId string

Source brand board ID if created from a template

Example:507f1f77bcf86cd799439011

sourceType string

How the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

]

totalCount numberrequired

Total number of brand boards matching the query

Example:42

{
  "brandBoards": [\
    {\
      "_id": "507f1f77bcf86cd799439011",\
      "name": "My Brand Board",\
      "updatedAt": "2024-01-05T12:00:00.000Z",\
      "default": false,\
      "meta": {\
        "updatedBy": "user_abc123",\
        "lastAction": "UPDATE",\
        "sourceId": "507f1f77bcf86cd799439011",\
        "sourceType": "blank"\
      }\
    }\
  ],
  "totalCount": 42
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

The token does not have access to this location

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:403

message string

Example:The token does not have access to this location

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

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: brand-boards/design-kit.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/brand-boards/:locationId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

Version — headerrequired

---2021-07-28

Show optional parameters

limit — query

offset — query

search — query

deleted — query

---truefalse

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Update Brand Board

Source: https://marketplace.gohighlevel.com/docs/ghl/brand-boards/update-brand-board

Skip to main content

Update a Brand Board

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

Updates an existing Brand Board

Requirements

Scope(s)

brand-boards/design-kit.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

locationId stringrequired

Location ID where the brand board exists

Example: ve9EPM428h8vShlRW1KT

id stringrequired

Brand board ID to update, retrieve, or delete

Example: 507f1f77bcf86cd799439011

  • application/json

Body required

name string

Name of the brand board

Example:My Brandboard 2

logos object[]

Array of logos for the brand board

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of colors for the brand board

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of fonts for the brand board

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default boolean

Set as the default brand board for this location

Example:true

parentId string

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

Example:507f1f77bcf86cd799439011

Responses ​

  • 200
  • 400
  • 401
  • 403
  • 404
  • 422

Success

  • application/json

  • Schema

  • Example (auto)

Schema

_id stringrequired

Brand board ID

Example:507f1f77bcf86cd799439011

locationId stringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Brand board name

Example:My Brand Board

logos object[]

Array of logos

Array [

id stringrequired

Unique identifier for the logo

Example:logo_abc123

url stringrequired

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 stringrequired

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

Example:Primary Logo

path stringrequired

Storage path of the logo in the media library

Example:/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png

]

colors object[]

Array of brand colors

Array [

id stringrequired

Unique identifier for the color

Example:color_xyz789

hexa stringrequired

Color in HEXA format (with alpha)

Example:#FF5733FF

rgba stringrequired

Color in RGBA format

Example:rgba(255, 87, 51, 1)

hex stringrequired

Color in HEX format

Example:#FF5733

rgb stringrequired

Color in RGB format

Example:rgb(255, 87, 51)

label stringrequired

Display label for the color

Example:Brand Orange

]

fonts object[]

Array of brand fonts

Array [

id stringrequired

Unique identifier for the font

Example:font_def456

font stringrequired

Font family name

Example:Montserrat

fallback stringrequired

Fallback font family

Example:sans-serif

label stringrequired

Display label for the font

Example:Heading Font

]

default booleanrequired

Whether this is the default brand board for the location

Example:false

deleted booleanrequired

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

meta object

Metadata about the brand board

updatedBy string

User ID who last updated the brand board

Example:user_abc123

lastAction string

Last action performed on the brand board

Example:UPDATE

sourceId string

Source brand board ID if created from a template

Example:507f1f77bcf86cd799439011

sourceType string

How the brand board was created

Possible values: [template, blank, snapshot]

Example:blank

createdAt string

Creation timestamp

Example:2024-01-05T12:00:00.000Z

updatedAt 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",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

The token does not have access to this location

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:403

message string

Example:The token does not have access to this location

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

Not Found

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:404

message string

Example:Not Found

error string

Example:The requested resource was not found

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

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: brand-boards/design-kit.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PATCH 'https://services.leadconnectorhq.com/brand-boards/:locationId/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-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"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

id — pathrequired

Version — headerrequired

---2021-07-28

Body required

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

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!