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

# Edit custom voice

> Update the name or description of a custom (cloned) voice.

Updates metadata on an existing custom voice. The underlying voice model is **not** re-trained — only `name` and `description` can change.

## Endpoint

```http theme={"dark"}
PATCH https://supertoneapi.com/v1/custom-voices/{voice_id}
```

## Path parameters

| Name       | Required | Description                         |
| ---------- | :------: | ----------------------------------- |
| `voice_id` |     ✅    | The ID of the custom voice to edit. |

## Request body

| Field         | Required | Description                         |
| ------------- | :------: | ----------------------------------- |
| `name`        |     —    | New voice name. Max 100 characters. |
| `description` |     —    | New description.                    |

At least one field must be provided.

## Notes

* The `voice_id` does not change. Existing references remain valid.
* Returns `403 Forbidden` if the voice belongs to a different account.

## See also

<CardGroup cols={2}>
  <Card title="Docs: Custom voices" icon="microphone" href="/en/docs/core-concepts/custom-voices">
    Full custom-voice lifecycle.
  </Card>

  <Card title="Delete custom voice" icon="trash" href="/en/api-reference/endpoints/delete-custom-voice">
    Permanently remove a custom voice.
  </Card>
</CardGroup>


## OpenAPI

````yaml /openapi.json patch /v1/custom-voices/{voice_id}
openapi: 3.0.0
info:
  title: Supertone Public API
  description: >-
    Supertone API is a RESTful API for using our state-of-the-art AI voice
    models.
  version: 0.9.6
  contact: {}
servers:
  - url: https://supertoneapi.com
    description: Production
security: []
tags:
  - name: voices
    description: Voice Library API endpoints
  - name: custom_voices
    description: Custom Voice Management API endpoints
  - name: text_to_speech
    description: Text-to-Speech API endpoints
  - name: usage
    description: Usage Analytics API endpoints
paths:
  /v1/custom-voices/{voice_id}:
    patch:
      tags:
        - custom_voices
      summary: Update cloned voice (partial update)
      description: Partially updates properties of a custom (cloned) voice by ID.
      operationId: edit_custom_voice
      parameters:
        - name: voice_id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomVoiceRequest'
      responses:
        '200':
          description: Voice updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomVoiceResponse'
        '401':
          description: 'Unauthorized: Invalid API key'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: 'Not Found: Voice does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
        '500':
          description: 'Internal Server Error: Failed to update cloned voice'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - api-key: []
components:
  schemas:
    UpdateCustomVoiceRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the voice
          example: My Updated Voice
        description:
          type: string
          description: Description of the voice
          example: An updated warm and friendly voice for customer service
    UpdateCustomVoiceResponse:
      type: object
      properties:
        voice_id:
          type: string
          description: Unique identifier for the voice
          example: voice_123456789
        name:
          type: string
          description: Name of the voice
          example: My Updated Voice
        description:
          type: string
          description: Description of the voice
          example: An updated warm and friendly voice for customer service
          nullable: true
      required:
        - voice_id
        - name
    UnauthorizedErrorResponse:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
        message:
          description: Unauthorized error details
          example:
            message: Invalid API Key
            error: Unauthorized
            statusCode: 401
          allOf:
            - $ref: '#/components/schemas/ErrorMessageData'
      required:
        - status
        - message
    NotFoundErrorResponse:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
        message:
          description: Not found error details
          example:
            message: Voice not found
            error: Not Found
            statusCode: 404
          allOf:
            - $ref: '#/components/schemas/ErrorMessageData'
      required:
        - status
        - message
    InternalServerErrorResponse:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
        message:
          description: Internal server error details
          example:
            message: Failed to convert text to speech
            error: Internal Server Error
            statusCode: 500
          allOf:
            - $ref: '#/components/schemas/ErrorMessageData'
      required:
        - status
        - message
    ErrorMessageData:
      type: object
      properties:
        message:
          type: string
          description: Error message
          example: Invalid API Key
        error:
          type: string
          description: Error type
          example: Unauthorized
        status_code:
          type: number
          description: HTTP status code
          example: 401
      required:
        - message
        - error
        - status_code
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-sup-api-key

````