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

# Update

> Change a character; references replace the whole list, and null clears identity notes or the voice

CLI: `adside characters update`



## OpenAPI

````yaml /api-reference/openapi.yaml patch /v1/workspaces/{workspaceId}/characters/{character}
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/characters/{character}:
    patch:
      tags:
        - Characters
      summary: Update
      description: >-
        Change a character; references replace the whole list, and null clears
        identity notes or the voice


        CLI: `adside characters update`
      operationId: characters.update
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: character
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 80
                handle:
                  type: string
                  minLength: 2
                  maxLength: 40
                  pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                kind:
                  type: string
                  enum:
                    - ai_person
                    - real_person
                    - mascot
                consentConfirmed:
                  type: boolean
                  const: true
                identityNotes:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 400
                    - type: 'null'
                voiceId:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 60
                    - type: 'null'
                references:
                  minItems: 1
                  maxItems: 8
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 64
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  character:
                    type: object
                    properties:
                      id:
                        type: string
                      handle:
                        type: string
                      name:
                        type: string
                      kind:
                        type: string
                        enum:
                          - ai_person
                          - real_person
                          - mascot
                      identityNotes:
                        anyOf:
                          - type: string
                          - type: 'null'
                      voiceId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      consentConfirmedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      references:
                        type: array
                        items:
                          type: object
                          properties:
                            assetId:
                              type: string
                            url:
                              type: string
                            mimeType:
                              type: string
                            width:
                              anyOf:
                                - type: number
                                - type: 'null'
                            height:
                              anyOf:
                                - type: number
                                - type: 'null'
                          required:
                            - assetId
                            - url
                            - mimeType
                            - width
                            - height
                          additionalProperties: false
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                      - id
                      - handle
                      - name
                      - kind
                      - identityNotes
                      - voiceId
                      - consentConfirmedAt
                      - references
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - character
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.