Brand VoicesVersion: v3New

Create Brand Voice

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

Create a brand voice for a location

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

Body

application/json

namestring

Name

Example:My Brand Voice

typestringrequired

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

Available optionsmanualurldescription

Example:manual

urlstring

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

Example:https://example.com

descriptionstring

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

Example:We are a tech company focused on innovative solutions for small businesses

answersobject

Brand voice answers. Required when type is "manual"

Response

application/json

Created

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