Skip to main content
PATCH
Change the brand voice

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json
formality
enum<string>
Available options:
casual,
conversational,
professional,
formal,
academic,
technical
emotionalTones
enum<string>[]
Maximum array length: 2
Available options:
warm,
authoritative,
playful,
inspirational,
empathetic,
bold,
trustworthy,
neutral,
urgent,
reassuring,
curious,
sincere
energyLevel
enum<string>
Available options:
calm,
balanced,
energetic,
intense
sentenceStyle
enum<string>
Available options:
short,
balanced,
long,
varied
pointOfView
enum<string>
Available options:
first-singular,
first-plural,
second,
third
audienceExpertise
enum<string>
Available options:
beginner,
intermediate,
expert
jargonLevel
enum<string>
Available options:
plain,
light,
standard,
technical
personalities
enum<string>[]
Maximum array length: 2
Available options:
friendly,
professional,
witty,
serious,
quirky,
corporate,
startup,
premium
persuasionStyles
enum<string>[]
Maximum array length: 2
Available options:
educational,
benefit-focused,
problem-solution,
story-driven,
data-driven,
social-proof
addressFormality
enum<string>
Available options:
informal,
formal,
neutral
syntaxPatterns
string[]
Maximum array length: 50
Required string length: 1 - 200
forbiddenCategories
enum<string>[]
Available options:
hyperbole,
sales-cliches,
business-jargon,
superlatives,
filler-words,
hedging
customBlacklist
string[]
Maximum array length: 20
Maximum string length: 30

Response

The brand voice after the change

data
object
required