Skip to main content
PATCH
/
voice_designs
/
{id}
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);
{
  "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"
  }
}

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

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