Skip to main content
Brand VoicesVersion: v3New

Update Brand Voice

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

Update a brand voice by ID

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:brand-boards/voices.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:oHJiAh0wDG3BzmzACVD6
brandVoiceIdstringrequired

Brand voice ID

Example:507f1f77bcf86cd799439011

Body

namestring

Name

Example:My Brand Voice
answersobject

Updated answers

Response

Success

idstringrequired

Brand voice ID

Example:507f1f77bcf86cd799439011
namestringrequired

Brand voice name

Example:My Brand Voice
isDefaultbooleanrequired

Whether this is the default brand voice

Example:false
createdAtstringrequired

Creation timestamp

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

Last update timestamp

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

Location ID

Example:oHJiAh0wDG3BzmzACVD6
deletedbooleanrequired

Whether the brand voice has been soft deleted

Example:false
answersobject

Brand voice answers

traceIdstring

Trace ID of request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4