Create Brand Voice

POST 
/brand-boards/public/v1/locations/:locationId/voices

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Create a brand voice for a location

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location ID

application/json

application/json

Body

Bodyrequired

namestring

Name

typestringrequired
Creation type. "manual" creates with provided custom answers, "url" generates answers from a website, "description" generates answers from a text description
Available optionsmanualurldescription
urlstring

Website URL to generate brand voice from. Required when type is "url"

descriptionstring

Company description to generate brand voice from. Required when type is "description", optional when type is "url"

answersobject

Brand voice answers. Required when type is "manual"

Example (auto)

{
  "name": "My Brand Voice",
  "type": "manual",
  "url": "https://example.com",
  "description": "We are a tech company focused on innovative solutions for small businesses",
  "answers": {
    "brandName": "Acme Inc",
    "toneOfVoice": "Professional and friendly",
    "targetAudience": "Small business owners",
    "customerPainPoints": "Difficulty with time management"
  }
}

application/json

Created

application/json

Schema

Schema

idstringrequired

Brand voice ID

namestringrequired

Brand voice name

isDefaultbooleanrequired

Whether this is the default brand voice

createdAtstringrequired

Creation timestamp

updatedAtstringrequired

Last update timestamp

locationIdstringrequired

Location ID

deletedbooleanrequired

Whether the brand voice has been soft deleted

answersobject

Brand voice answers

traceIdstring

Trace ID of request

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "name": "My Brand Voice",
  "isDefault": false,
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z",
  "locationId": "oHJiAh0wDG3BzmzACVD6",
  "deleted": false,
  "answers": {
    "brandName": "Acme Inc",
    "toneOfVoice": "Professional and friendly",
    "targetAudience": "Small business owners",
    "customerPainPoints": "Difficulty with time management",
    "businessType": "Software Development",
    "companyWebsite": "https://example.com",
    "companyEmail": "[email protected]",
    "companyAddress": "123 Main St, Anytown, CA",
    "phone": {
      "phoneNumber": "5551234567",
      "countryCode": "US"
    },
    "businessHours": "Mon-Fri 9am-5pm",
    "brandPromise": "We deliver on time, every time",
    "brandValues": "Integrity, Excellence, Innovation",
    "brandPurpose": "To empower small businesses with technology",
    "competitiveAdvantage": "Proprietary AI technology",
    "risksOfInaction": "Falling behind competitors",
    "uniqueSellingProposition": "The only solution that integrates with all major platforms",
    "callToAction": "Schedule a demo today"
  },
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}