Rename a voice design

Updates the name of a voice design. All versions retain their other properties.

PATCH /voice_designs/{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 response = await client.voiceDesigns.rename('id', { name: 'updated-narrator' });

console.log(response.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
)
response = client.voice_designs.rename(
    id="id",
    name="updated-narrator",
)
print(response.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"),
	)
	response, err := client.VoiceDesigns.Rename(
		context.TODO(),
		"id",
		telnyx.VoiceDesignRenameParams{
			Name: "updated-narrator",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.voicedesigns.VoiceDesignRenameParams;
import com.telnyx.sdk.models.voicedesigns.VoiceDesignRenameResponse;

public final class Main {
    private Main() {}

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

        VoiceDesignRenameParams params = VoiceDesignRenameParams.builder()
            .id("id")
            .name("updated-narrator")
            .build();
        VoiceDesignRenameResponse response = client.voiceDesigns().rename(params);
    }
}

require "telnyx"

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

response = telnyx.voice_designs.rename("id", name: "updated-narrator")

puts(response)

<?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 {
  $response = $client->voiceDesigns->rename('id', name: 'updated-narrator');

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

telnyx voice-designs rename \
  --api-key 'My API Key' \
  --id id \
  --name updated-narrator

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

200

{
  "data": {
    "record_type": "voice_design",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "updated-narrator",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-02T00:00:00Z"
  }
}

{
  "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 · required

The voice design UUID or name.

Body

application/json

Request body for renaming a voice design.

name · string · required

New name for the voice design.

Required string length: 1 - 255

Response

200

application/json

Voice design renamed successfully.

Response envelope for a voice design after a rename operation (no version-specific fields).

data · object

A summarized voice design object (without version-specific fields).

Show child attributes