Skip to main content

Update a brand voice

Log in to add to favourites

Page last updated 12 June 2026

Endpoint for updating the current Brand Voice.
PUTapi/management/projects/{projectId}/ai/brandvoices/{brandVoiceId}

Parameters

NameParameter typeTypeDescription
projectId(required)pathstringThe project identifier found in the project overview screen of the management console.
brandVoiceId(required)pathstringThe brand voice string Id
Brand Voice Request(required)bodyobjectBrand Voice request model

Responses

HTTP status codeReasonModel
200OKBrand Voice
401UnauthorizedError
404Project not foundError
404Not FoundError
422Validation error(s)Error
500Internal server errorError

Examples

HTTP
PUT: /api/management/projects/website/ai/brandvoice/brand-voice-id
{
  "name" : "An updated Brand Voice",
  "id" : "contensisBlog",
  "description" : "An updated description",
  "training" : {
    "text" : "Text to train the model and generate a customized brand voice",
    "urls" : [ "https://www.contensis.com/community/blog/content-personalisation-101-what-it-is-why-it-matters-and-how-to-do-it-well" ]
  },
  "summary" : "The brand voice is approachable yet knowledgeable, blending clarity with helpful authority to guide readers through complex content personalisation concepts in an encouraging and pragmatic way.",
  "tone" : "A new tone",
  "personalityTraits" : "friendly, supportive, knowledgeable, practical",
  "languageComplexity" : "simple to intermediate",
  "sentenceStructure" : "short to medium-length, clear and direct",
  "vocabularyChoices" : "industry terminology explained clearly, approachable phrasing",
  "useOfLiteraryDevices" : "occasional rhetorical questions, direct address (\"you\"), analogies, gentle reassurance",
  "uniqueCharacteristics" : "breaks down complex ideas into manageable steps; reassures and motivates the reader; uses inclusive language to demystify digital concepts",
  "detectedReadingEaseScore" : 38,
  "readingEaseOverride" : "Difficult",
  "inclusivity" : {
    "avoidCulturalOrReligiousReferences" : true,
    "useGenderNeutralNounsAndPronouns" : true,
    "avoidIdiomsSlangAndAcronyms" : true
  },
  "termsToAvoid" : "synergy",
  "version" : {
    "versionNo" : "0.2"
  }
}
Example Update
JSON
{
  "name" : "An updated Brand Voice",
  "id" : "brand-voice-id",
  "description" : "An updated description",
  "training" : {
    "text" : "Text to train the model and generate a customized brand voice",
    "urls" : [ "https://www.contensis.com/community/blog/content-personalisation-101-what-it-is-why-it-matters-and-how-to-do-it-well" ]
  },
  "summary" : "The brand voice is approachable yet knowledgeable, blending clarity with helpful authority to guide readers through complex content personalisation concepts in an encouraging and pragmatic way.",
  "tone" : "A new tone",
  "personalityTraits" : "friendly, supportive, knowledgeable, practical",
  "languageComplexity" : "simple to intermediate",
  "sentenceStructure" : "short to medium-length, clear and direct",
  "vocabularyChoices" : "industry terminology explained clearly, approachable phrasing",
  "useOfLiteraryDevices" : "occasional rhetorical questions, direct address (\"you\"), analogies, gentle reassurance",
  "uniqueCharacteristics" : "breaks down complex ideas into manageable steps; reassures and motivates the reader; uses inclusive language to demystify digital concepts",
  "detectedReadingEaseScore" : 38,
  "readingEaseOverride" : "Difficult",
  "inclusivity" : {
    "avoidCulturalOrReligiousReferences" : true,
    "useGenderNeutralNounsAndPronouns" : true,
    "avoidIdiomsSlangAndAcronyms" : true
  },
  "termsToAvoid" : "synergy",
  "version" : {
    "versionNo" : "0.1"
  }
}

Remarks

You must be part of the System Administrators group or be part of the Brand Voice Update role.

A Brand Voice must already exist in order for the update to work.

A new version number must be passed as part of the request to update a Brand Voice.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request