Documentación
superleads.mx
Documentación › Referencia de la API › Brand Boards

Brand Boards

Referencia de la API · ☕ 9 min de lectura
Actualizado el 19 Jun 2026

Brand Boards API v3

Documentación de la API de Brand Boards

API Versión v3

Todos los endpoints estan disponibles bajo el prefijo /v3, con respuestas que siguen el estandar AIP.

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /brand-boards/locations/{locationId}/brand-voices

Listar Brand Voices Get list of brand voices for a location

Parametros: - locationId (path, string) (requerido) — Id de sede - limit (query, number) — Number of brand voices to return. Defaults to 10, minimum is 1, maximum is 20 - offset (query, number) — Number of brand voices to skip for pagination. Defaults to 0, minimum is 0 - search (query, string) — Search text for brand voice name - deleted (query, boolean) — Whether to return deleted brand voices. Defaults to false - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

POST /brand-boards/locations/{locationId}/brand-voices

Crear Brand Voice Create a brand voice for a location

Parametros: - locationId (path, string) (requerido) — Id de sede - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name — string — Name - type (requerido) — string — Creation type. "manual" creates with provided custom answers, "url" generates answers from a website, "description" generates answers from a text description - url — string — Website URL to generate brand voice from. Required when type is "url" - description — string — Company description to generate brand voice from. Required when type is "description", optional when type is "url" - answers — — Brand voice answers. Required when type is "manual"

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

Obtener Brand Voice Get a brand voice by Id

Parametros: - locationId (path, string) (requerido) — Id de sede - brandVoiceId (path, string) (requerido) — Id de Brand voice - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

Actualizar Brand Voice Update a brand voice by Id

Parametros: - locationId (path, string) (requerido) — Id de sede - brandVoiceId (path, string) (requerido) — Id de Brand voice - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name — string — Name - answers — — Updated answers

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

Eliminar Brand Voice Delete a brand voice by Id

Parametros: - locationId (path, string) (requerido) — Id de sede - brandVoiceId (path, string) (requerido) — Id de Brand voice - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default

Set Default Brand Voice Set a brand voice as the default for a location. The previous default will be unset.

Parametros: - locationId (path, string) (requerido) — Id de sede - brandVoiceId (path, string) (requerido) — Id de Brand voice - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado

GET /brand-boards/{locationId}

Obtener tableros de marca Retrieves all Brand Boards for a specific location

Scopes requeridos: brand-boards/design-kit.readonly

Parametros: - locationId (path, string) (requerido) — Location Id where the brand boards exist - limit (query, number) — Maximum number of brand boards to return - offset (query, number) — Number of brand boards to skip for pagination - search (query, string) — Search term to filter brand boards by name - deleted (query, boolean) — Include deleted brand boards in results - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 422 — Entidad no procesable

GET /brand-boards/{locationId}/{id}

Obtener tablero de marca Retrieves a specific Brand Board by its Id

Scopes requeridos: brand-boards/design-kit.readonly

Parametros: - locationId (path, string) (requerido) — Location Id where the brand board exists - id (path, string) (requerido) — Brand board Id to update, retrieve, or delete - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

PATCH /brand-boards/{locationId}/{id}

Actualizar a Brand Board Updates an existing Brand Board

Scopes requeridos: brand-boards/design-kit.write

Parametros: - locationId (path, string) (requerido) — Location Id where the brand board exists - id (path, string) (requerido) — Brand board Id to update, retrieve, or delete - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name — string — Name of the brand board - logos — array — Array of logos for the brand board - id — string — Unique identifier for the logo - url (requerido) — string — Public URL of the logo image. Used for uploading to the brand board folder in media library - label (requerido) — string — Display label for the logo (e.g., Primary, Secondary) - path (requerido) — string — Storage path of the logo in the media library - colors — array — Array of colors for the brand board - id — string — Unique identifier for the color - hexa (requerido) — string — Color in 8-digit hexadecimal notation with alpha channel - rgba (requerido) — string — Color with red, green, blue, and alpha channel values - hex (requerido) — string — Color in HEX format - rgb (requerido) — string — Color in RGB format - label (requerido) — string — Display label for the color - fonts — array — Array of fonts for the brand board - id — string — Unique identifier for the font - font (requerido) — string — Font family name - fallback (requerido) — string — Fallback font family - label (requerido) — string — Display label for the font - default — boolean — Set as the default brand board for this location - parentId — string — Parent folder Id in media library (reserved for future use)

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

DELETE /brand-boards/{locationId}/{id}

Eliminar a Brand Board Deletes a Brand Board

Scopes requeridos: brand-boards/design-kit.write

Parametros: - locationId (path, string) (requerido) — Location Id where the brand board exists - id (path, string) (requerido) — Brand board Id to update, retrieve, or delete - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

POST /brand-boards/

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

Scopes requeridos: brand-boards/design-kit.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id where the brand board will be created - name (requerido) — string — Name of the brand board - logos — array — Array of logos for the brand board - id — string — Unique identifier for the logo - url (requerido) — string — Public URL of the logo image. Used for uploading to the brand board folder in media library - label (requerido) — string — Display label for the logo (e.g., Primary, Secondary) - path (requerido) — string — Storage path of the logo in the media library - colors — array — Array of colors for the brand board - id — string — Unique identifier for the color - hexa (requerido) — string — Color in 8-digit hexadecimal notation with alpha channel - rgba (requerido) — string — Color with red, green, blue, and alpha channel values - hex (requerido) — string — Color in HEX format - rgb (requerido) — string — Color in RGB format - label (requerido) — string — Display label for the color - fonts — array — Array of fonts for the brand board - id — string — Unique identifier for the font - font (requerido) — string — Font family name - fallback (requerido) — string — Fallback font family - label (requerido) — string — Display label for the font - default — boolean — Set as the default brand board for this location - brandBoardId — string — Source brand board Id to copy from (creates a new brand board based on this template) - parentId — string — Parent folder Id in media library for organizing brand boards - type — string — Source type indicating how the brand board was created - url — string — Website URL to extract design kit from (colors, fonts, logos)

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar