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);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
voice_clone = client.voice_clones.update(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    name="updated-clone",
)
print(voice_clone.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	voiceClone, err := client.VoiceClones.Update(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.VoiceCloneUpdateParams{
			Name: "updated-clone",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", voiceClone.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.voiceclones.VoiceCloneUpdateParams;
import com.telnyx.sdk.models.voiceclones.VoiceCloneUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        VoiceCloneUpdateParams params = VoiceCloneUpdateParams.builder()
            .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .name("updated-clone")
            .build();
        VoiceCloneUpdateResponse voiceClone = client.voiceClones().update(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

voice_clone = telnyx.voice_clones.update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", name: "updated-clone")

puts(voice_clone)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $voiceClone = $client->voiceClones->update(
    '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    name: 'updated-clone',
    gender: 'male',
    language: 'language',
  );

  var_dump($voiceClone);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx voice-clones update \
  --api-key 'My API Key' \
  --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \
  --name updated-clone

curl --request PATCH \
  --url https://api.telnyx.com/v2/voice_clones/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "updated-clone"
}
'

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",
    "model_id": "Qwen3TTS",
    "status": "active"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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