Skip to main content
PUT
Update an existing voice by its ID

Authorizations

Authorization
string
header
required

Headers

x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

id
string
required

ID of the voice to update

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

Payload for updating the voice

name
string
Minimum string length: 5
isMultilingual
boolean
supportedLocales
enum<string>[]
Available options:
en-US,
en-GB,
en-AU,
en-CA,
en-IE,
en-IN,
en-NZ,
en-ZA,
en-SG,
es-ES,
es-MX,
es-AR,
es-CL,
es-PE,
fr-FR,
pt-BR,
pt-PT,
zh-CN,
cmn-EN,
nl-NL,
fi-FI,
de-DE,
de-AT,
de-CH,
de-LU,
de-LI,
gsw-CH,
gsw-LI,
el-GR,
hi-IN,
en-TA,
id-ID,
it-IT,
ja-JP,
ko-KR,
ms-MY,
en-MS,
ro-RO,
ru-RU,
uk-UA,
ka-GE,
bg-BG,
cs-CZ,
da-DK,
pl-PL,
sk-SK,
sv-SE,
tr-TR,
ar-SA,
ary-MA,
arz-EG,
apc-LB,
apc-SY,
apc-PS,
apc-JO,
acm-IQ,
ar-AE,
afb-AE,
afb-BH,
afb-KW,
afb-QA,
afb-OM,
hr-HR,
hr-BA,
he-IL,
ur-PK,
hu-HU,
fil-PH,
th-TH,
vi-VN
settings
object
gender
enum<string>
Available options:
MALE,
FEMALE

Response

The updated Voice object

id
string
required

The ID of the voice

voiceId
string
required

The provider-specific voice ID

name
string
required

The name of the voice

isMultilingual
boolean
required

Indicates if the voice supports multiple languages

supportedLocales
string[]
required

Array of supported locale strings

ttsClient
string
required

Identifier for the TTS (text-to-speech) client

gender
enum<string>
required

The gender of the voice

Available options:
MALE,
FEMALE
organizationId
string

The organization ID that owns this voice

settings
object

Additional settings stored in JSON format

Example: