HighLevel: Create Brand Voice

← Brand boards operations · Get started

Operation gohighlevel.create_brand_voice

Provider route: POST /brand-boards/locations/{locationId}/brand-voices. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["brandBoards"]["createBrandVoice"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.brandBoards.createBrandVoice(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.brand_boards.create_brand_voice(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
body	Model	Required within parent	Expand Create Brand Voice — request body — body

Referenced models: Create Brand Voice — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Brand Voice — response body

Referenced models: Get Brand Voice — response body

Schemas

Create Brand Voice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
answers	JSON	Optional	Brand voice answers. Required when type is "manual"
answers (allOf 1)	Model	All variants apply	Expand Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition
description	string	Optional	Company description to generate brand voice from. Required when type is "description", optional when type is "url"
name	string	Optional	Name
type	string	Required within parent	Creation type. "manual" creates with provided custom answers, "url" generates answers from a website, "description" generates answers from a text description One of: manual, url, description
url	string	Optional	Website URL to generate brand voice from. Required when type is "url"

Referenced models: Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Get Brand Voice — response body

Field	Type	Presence	Description and constraints
$	object	Root
answers	JSON	Optional	Brand voice answers
answers (allOf 1)	Model	All variants apply	Expand Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition
createdAt	string	Required within parent	Creation timestamp
deleted	boolean	Required within parent	Whether the brand voice has been soft deleted
id	string	Required within parent	Brand voice ID
isDefault	boolean	Required within parent	Whether this is the default brand voice
locationId	string	Required within parent	Location ID
name	string	Required within parent	Brand voice name
traceId	string	Optional	Trace ID of request
updatedAt	string	Required within parent	Last update timestamp

Referenced models: Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Create Brand Voice — request body — body answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Field	Type	Presence	Description and constraints
$	object	Root
brandName	string	Required within parent	Brand Name
brandPromise	string	Optional	Brand Promise
brandPurpose	string	Optional	Brand Purpose
brandValues	string	Optional	Brand Values
businessHours	string	Optional	Business Hours
businessType	string	Optional	Business Type
callToAction	string	Optional	Call to Action
companyAddress	string	Optional	Company Address
companyEmail	string	Optional	Company Email
companyWebsite	string	Optional	Company Website
competitiveAdvantage	string	Optional	Competitive Advantage
customerPainPoints	string	Required within parent	Customer Pain Points
phone	object	Optional	Phone Information
risksOfInaction	string	Optional	Risks of Inaction
targetAudience	string	Required within parent	Target Audience
toneOfVoice	string	Required within parent	Tone of Voice
uniqueSellingProposition	string	Optional	Unique Selling Proposition

Get Brand Voice — response body — answers brand Name, brand Promise, brand Purpose, brand Values, business Hours, business Type, call To Action, company Address, company Email, company Website, competitive Advantage, customer Pain Points, phone, risks Of Inaction, target Audience, tone Of Voice, unique Selling Proposition

Field	Type	Presence	Description and constraints
$	object	Root
brandName	string	Optional	Brand Name
brandPromise	string	Optional	Brand Promise
brandPurpose	string	Optional	Brand Purpose
brandValues	string	Optional	Brand Values
businessHours	string	Optional	Business Hours
businessType	string	Optional	Business Type
callToAction	string	Optional	Call to Action
companyAddress	string	Optional	Company Address
companyEmail	string	Optional	Company Email
companyWebsite	string	Optional	Company Website
competitiveAdvantage	string	Optional	Competitive Advantage
customerPainPoints	string	Optional	Customer Pain Points
phone	object	Optional	Phone Information
risksOfInaction	string	Optional	Risks of Inaction
targetAudience	string	Optional	Target Audience
toneOfVoice	string	Optional	Tone of Voice
uniqueSellingProposition	string	Optional	Unique Selling Proposition

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_brand_voice. Catalog operation: create-brand-voice. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source