Sign in

v5

latestOpenAPI 3.1.12026-07-31392595.5 KB
Content

Update a single brand identity

Updates brand identity fields. Pass isDefault: true to make the target brand identity the organization's default.

patch/v1/brand-identities/{brandIdentityId}

Path parameters

brandIdentityIdstring required
Example:51c2f3aa-efdd-4e28-8e69-23fa2dfd3561

Request body

namestring
websiteUrlstring
companyNamestring nullable
companyDescriptionstring nullable
toneProfile'Conversational' | 'Professional' | 'Casual' | 'Formal' | 'null' nullable

Set a preset tone profile. When provided without customTone, any saved custom tone is cleared.

customTonestring nullable

Provide a custom tone override. Send an empty string or null to clear it.

customInstructionsstring nullable
audiencestring nullable
language'English' | 'Spanish' | 'French' | 'German' | 'Portuguese' | 'Dutch' | 'Italian' | 'Japanese' | 'Korean' | 'Chinese' | 'Arabic' | 'Hindi' | 'Russian' | 'Turkish' | 'Polish' | 'Swedish' | 'Danish' | 'Norwegian' | 'Finnish' | 'Czech' | 'Romanian' | 'Hungarian' | 'Greek' | 'Thai' | 'Vietnamese' | 'Indonesian' | 'Ukrainian' | 'Hebrew' | 'null' nullable
isDefaulttrue

Set this brand identity as the organization's default. Only true is accepted.

Example request

{
  "name": "Notra",
  "websiteUrl": "https://usenotra.com",
  "companyName": "Notra",
  "companyDescription": "AI-native content workflows for software teams.",
  "toneProfile": "Professional",
  "customTone": "Clear, direct, and technically confident",
  "customInstructions": "Avoid hype. Prioritize concrete examples.",
  "audience": "Engineering leaders and developer tooling teams.",
  "language": "English",
  "isDefault": true
}

Response

Brand identity updated successfully