> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Brand Voice

> Update an existing brand voice



## OpenAPI

````yaml post /api/v2/brand-voice/update
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/brand-voice/update:
    post:
      tags:
        - Brand Voice
      summary: Update Brand Voice
      description: Update an existing brand voice
      operationId: updateBrandVoice
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                oId:
                  type: string
                  description: Brand Voice OId
                name:
                  type: string
                  description: Brand Voice name
                data:
                  type: object
                  properties:
                    title:
                      type: string
                      description: The name/title of the brand voice
                      example: Enterprise Brand Voice
                    description:
                      type: string
                      description: High-level description of this brand voice
                      example: >-
                        Professional and authoritative tone for enterprise
                        audiences
                    essence:
                      type: string
                      nullable: true
                      description: The core essence or soul of the brand voice
                      example: Clear, concise, and confident
                    personality:
                      type: object
                      properties:
                        coreTraits:
                          type: array
                          items:
                            type: string
                          description: Core personality traits that define the brand voice
                          example:
                            - Professional
                            - Authoritative
                            - Empathetic
                        guidingPrinciples:
                          type: array
                          items:
                            type: string
                          description: Guiding principles for communication style
                          example:
                            - Clarity over cleverness
                            - Lead with value
                      required:
                        - coreTraits
                        - guidingPrinciples
                      description: Brand personality definition
                    tonality:
                      type: object
                      properties:
                        soundLike:
                          type: array
                          items:
                            type: string
                          description: Desired tonal qualities the brand should embody
                          example:
                            - Confident expert
                            - Trusted advisor
                        neverSoundLike:
                          type: array
                          items:
                            type: string
                          description: Tonal qualities the brand should avoid
                          example:
                            - Pushy salesperson
                            - Corporate jargon
                      required:
                        - soundLike
                        - neverSoundLike
                      description: Brand tonality guidelines
                    vocabulary:
                      type: object
                      properties:
                        keyCompanyTerms:
                          type: array
                          items:
                            type: string
                          description: Preferred company-specific terminology
                          example:
                            - Octave
                            - knowledge graph
                            - GTM intelligence
                        keySubstitutions:
                          type: array
                          items:
                            type: string
                          description: Word or phrase substitutions to enforce
                          example:
                            - Say 'revenue team' not 'sales team'
                      required:
                        - keyCompanyTerms
                        - keySubstitutions
                      description: Vocabulary preferences and terminology
                    writingRules:
                      type: object
                      properties:
                        languageRules:
                          type: array
                          items:
                            type: string
                          description: Grammatical and language rules to follow
                          example:
                            - Use active voice
                            - Avoid passive constructions
                        formattingFundamentals:
                          type: array
                          items:
                            type: string
                          description: Formatting guidelines for content structure
                          example:
                            - Short paragraphs
                            - Bullet points for lists
                      required:
                        - languageRules
                        - formattingFundamentals
                      description: Writing style and formatting rules
                    audienceConsiderations:
                      type: object
                      properties:
                        qualitiesAndCharacteristics:
                          type: array
                          items:
                            type: string
                          description: >-
                            Key qualities and characteristics of the target
                            audience
                          example:
                            - Technical decision makers
                            - Data-driven professionals
                        aspirationsAndBoundaries:
                          type: array
                          items:
                            type: string
                          description: >-
                            Audience aspirations to address and communication
                            boundaries to respect
                          example:
                            - Want actionable insights
                            - No fluff or filler
                      required:
                        - qualitiesAndCharacteristics
                        - aspirationsAndBoundaries
                      description: Target audience considerations
                    customFields:
                      $ref: '#/components/schemas/CustomDataFields'
                  required:
                    - title
                    - description
                    - personality
                    - tonality
                    - vocabulary
                    - writingRules
                    - audienceConsiderations
                  description: Brand Voice data
              required:
                - oId
      responses:
        '200':
          description: Updated brand voice
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    $ref: '#/components/schemas/BrandVoice'
                required:
                  - _metadata
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    CustomDataFields:
      type: array
      items:
        $ref: '#/components/schemas/CustomDataFieldItem'
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          description: API usage
          example: 0
        requestId:
          type: string
          description: Request ID
          example: requestId
        message:
          type: string
          description: Message
          example: message
        timestamp:
          type: string
          description: Timestamp
          example: '2021-01-01T00:00:00.000Z'
      required:
        - requestId
        - timestamp
    BrandVoice:
      type: object
      properties:
        oId:
          type: string
          description: Brand Voice OId
        createdAt:
          type: string
          nullable: true
          description: Creation date
        updatedAt:
          type: string
          nullable: true
          description: Updated date
        deletedAt:
          type: string
          nullable: true
          description: Deleted date
        name:
          type: string
          description: Brand Voice name
        data:
          $ref: '#/components/schemas/BrandVoiceData'
        default:
          type: boolean
          default: false
          description: Whether this is the default brand voice for the workspace
        user:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
            firstName:
              type: string
              nullable: true
            lastName:
              type: string
              nullable: true
          description: User data
        workspace:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
          description: Workspace data
      required:
        - oId
        - createdAt
        - updatedAt
        - name
    CustomDataFieldItem:
      type: object
      properties:
        title:
          type: string
        value:
          type: array
          items:
            type: string
      required:
        - title
        - value
    BrandVoiceData:
      type: object
      nullable: true
      properties:
        title:
          type: string
          description: The name/title of the brand voice
          example: Enterprise Brand Voice
        description:
          type: string
          description: High-level description of this brand voice
          example: Professional and authoritative tone for enterprise audiences
        essence:
          type: string
          nullable: true
          description: The core essence or soul of the brand voice
          example: Clear, concise, and confident
        personality:
          type: object
          properties:
            coreTraits:
              type: array
              items:
                type: string
              description: Core personality traits that define the brand voice
              example:
                - Professional
                - Authoritative
                - Empathetic
            guidingPrinciples:
              type: array
              items:
                type: string
              description: Guiding principles for communication style
              example:
                - Clarity over cleverness
                - Lead with value
          required:
            - coreTraits
            - guidingPrinciples
          description: Brand personality definition
        tonality:
          type: object
          properties:
            soundLike:
              type: array
              items:
                type: string
              description: Desired tonal qualities the brand should embody
              example:
                - Confident expert
                - Trusted advisor
            neverSoundLike:
              type: array
              items:
                type: string
              description: Tonal qualities the brand should avoid
              example:
                - Pushy salesperson
                - Corporate jargon
          required:
            - soundLike
            - neverSoundLike
          description: Brand tonality guidelines
        vocabulary:
          type: object
          properties:
            keyCompanyTerms:
              type: array
              items:
                type: string
              description: Preferred company-specific terminology
              example:
                - Octave
                - knowledge graph
                - GTM intelligence
            keySubstitutions:
              type: array
              items:
                type: string
              description: Word or phrase substitutions to enforce
              example:
                - Say 'revenue team' not 'sales team'
          required:
            - keyCompanyTerms
            - keySubstitutions
          description: Vocabulary preferences and terminology
        writingRules:
          type: object
          properties:
            languageRules:
              type: array
              items:
                type: string
              description: Grammatical and language rules to follow
              example:
                - Use active voice
                - Avoid passive constructions
            formattingFundamentals:
              type: array
              items:
                type: string
              description: Formatting guidelines for content structure
              example:
                - Short paragraphs
                - Bullet points for lists
          required:
            - languageRules
            - formattingFundamentals
          description: Writing style and formatting rules
        audienceConsiderations:
          type: object
          properties:
            qualitiesAndCharacteristics:
              type: array
              items:
                type: string
              description: Key qualities and characteristics of the target audience
              example:
                - Technical decision makers
                - Data-driven professionals
            aspirationsAndBoundaries:
              type: array
              items:
                type: string
              description: >-
                Audience aspirations to address and communication boundaries to
                respect
              example:
                - Want actionable insights
                - No fluff or filler
          required:
            - qualitiesAndCharacteristics
            - aspirationsAndBoundaries
          description: Target audience considerations
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
      required:
        - title
        - description
        - personality
        - tonality
        - vocabulary
        - writingRules
        - audienceConsiderations
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````