Update a voice clone

Updates the name, language, or gender of a voice clone.

PATCH /voice_clones/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const voiceClone = await client.voiceClones.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  name: 'updated-clone',
});

console.log(voiceClone.data);

200

{
  "data": {
    "record_type": "voice_clone",
    "id": "660f9511-f3ac-52e5-b827-557766551111",
    "source_voice_design_id": "550e8400-e29b-41d4-a716-446655440000",
    "source_voice_design_version": 1,
    "name": "clone-narrator",
    "language": "en",
    "gender": "male",
    "label": "Speak in a warm, friendly tone",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "provider": "Telnyx",
    "provider_supported_models": [
      "Qwen3TTS"
    ],
    "provider_voice_id": "660f9511-f3ac-52e5-b827-557766551111"
  }
}

Path Parameters

id · string<uuid> · required

The voice clone UUID.

Body

application/json

Request body for updating a voice clone.

name · string · required

New name for the voice clone.

Required string length: 1 - 255

language · string

Updated ISO 639-1 language code or auto.

gender · enum<string>

Updated gender for the voice clone.

Available options: male, female, neutral

Response

200

application/json

Voice clone updated successfully.

Response envelope for a single voice clone.

data · object

A voice clone object.

Show child attributes