Update Brand Voice

PATCH 
/brand-boards/locations/:locationId/brand-voices/:brandVoiceId

Update a brand voice by ID

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID

brandVoiceId stringrequired

Brand voice ID

application/json

application/json

Body

Bodyrequired

namestring

Name

answersobject

Updated answers

Example (auto)

{
  "name": "My Brand Voice",
  "answers": {
    "brandName": "Brand Name",
    "toneOfVoice": "Friendly"
  }
}

application/json

Success

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