Zoice For Developers | Zoice API

Update Voice Profile API Docs

Use the PATCH /v1/voice-profiles/{voice_id} endpoint to update the voice metadata, i.e., update the voice_name, gender, age, language, accent and/or description assigned to the specific voice profile using its voice_id.

API Request

Specify the fields you would like changed in the body of the request, such as voice_name, gender, age, language, accent and description. The voice_id value of the specific voice profile to be updated should be added as a path parameter in the request.

Sending Request

bash

curl -X PATCH "https://api.zoice.com/v1/voice-profiles/b92d8cc4-f3fa-4624..." \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ZOICE_API_KEY" \
  -d '{
    "voice_name": "George",
	"gender": "male",
    "age": "senior",
    "language": "fr",
    "accent": "fr-swiss",
    "description": "senior man updated voice"
  }'

Response Format

json

{
  "status": "success",
  "voice": {
    "voice_id": "b92d8cc4-f3fa-4624-...",
    "voice_name": "George",
    "description": "senior man updated voice",
    "age": "senior",
    "gender": "male",
    "language": "fr",
    "accent": "fr-swiss",
	"voice_type": "private",
	"voice_state": "active",
	"preview_url": "https://storage.zoice.com/api/assets/audio-8deb3582-33fb-....mp3",
    "generation_info": {
      "reference_audio_urls": [
        "https://storage.zoice.com/api/assets/2f242447-afd7-4576...mp3"
      ]
    },
    "created_at": "2026-05-29T19:12:28.466Z"
  }
}

Schema

Input

Path Parameter	Type	Required	Default	Range
voice_id	string	Yes	-	a valid UUID string.

Query Parameter	Type	Required	Default	Range
voice_name	string	No	-	A string
gender	string	No	-	`male`, `female`, `other`
age	string	No	-	`child`, `teen`, `young-adult`, `early-middle-aged`, `late-middle-aged`, `senior`
language	string	No	-	"af", "ar", "hy", "as", "ast", "az", "be", "bn", "bs", "bg", "yue", "ca", "ceb", "ny", "zh", "hr", "cs", "da", "nl", "en", "et", "fil", "fi", "fr", "gl", "ka", "de", "el", "gu", "ha", "he", "hi", "hu", "is", "id", "ga", "it", "ja", "jv", "kn", "kk", "ky", "ko", "lv", "ln", "lt", "lb", "mk", "ms", "ml", "mt", "mi", "mr", "mn", "ne", "no", "oc", "or", "ps", "fa", "pl", "pt", "pa", "ro", "ru", "sr", "sd", "sk", "sl", "so", "es", "sw", "sv", "tg", "ta", "te", "th", "tr", "uk", "ur", "uz", "vi", "cy"
accent	string	No	-	"af-standard", "ar-modern-standard", "ar-egyptian", "ar-gulf", "ar-levantine", "ar-bahraini", "ar-kuwaiti", "ar-omani", "ar-qatari", "ar-saudi", "ar-iraqi", "ar-jordanian", "ar-palestinian", "ar-syrian", "ar-algerian", "ar-moroccan", "ar-tunisian", "ar-libyan", "ar-sudanese", "hy-standard", "as-standard", "az-standard", "be-standard", "bn-standard", "bs-standard", "bg-bansko", "bg-rhodopean", "bg-ruse", "bg-sofia", "bg-standard", "bg-varna", "ca-standard", "ceb-standard", "ny-standard", "zh-guangzhou-cantonese", "zh-hong-kong-cantonese", "zh-singapore-cantonese", "zh-beijing-mandarin", "zh-singapore-mandarin", "zh-taiwan-mandarin", "zh-standard", "hr-dubrovnik", "hr-istrian", "hr-standard", "hr-zagreb", "cs-moravian", "cs-prague", "cs-silesian", "cs-standard", "da-copenhagen", "da-jutlandic", "da-standard", "da-zealandic", "nl-brabantian", "nl-flemish", "nl-gronings", "nl-limburgish", "nl-standard", "en-american", "en-australian", "en-british", "en-canadian", "en-indian", "en-irish", "en-jamaican", "en-new-zealand", "en-nigerian", "en-scottish", "en-south-african", "en-african-american", "en-singaporean", "en-boston", "en-chicago", "en-new-york", "en-us-southern", "en-us-midwest", "en-us-northeast", "en-cockney", "en-geordie", "en-received-pronunciation", "en-scouse", "en-welsh", "en-yorkshire", "en-arabic", "en-bulgarian", "en-chinese", "en-croatian", "en-czech", "en-danish", "en-dutch", "en-filipino", "en-finnish", "en-french", "en-german", "en-greek", "en-hindi", "en-indonesian", "en-italian", "en-japanese", "en-korean", "en-malay", "en-polish", "en-portuguese", "en-romanian", "en-russian", "en-slovak", "en-spanish", "en-swedish", "en-tamil", "en-turkish", "en-ukrainian", "et-standard", "fil-cebuano", "fil-ilocano", "fil-standard", "fi-eastern", "fi-helsinki", "fi-standard", "fi-tampere", "fi-turku", "fi-western", "fr-acadian", "fr-african", "fr-belgian", "fr-cajun", "fr-creole", "fr-meridional", "fr-parisian", "fr-quebec", "fr-standard", "fr-swiss", "gl-standard", "ka-standard", "de-bavarian", "de-berlinerisch", "de-rhine-franconian", "de-saxon", "de-standard", "de-swabian", "el-aegean", "el-athenian", "el-cretan", "el-cypriot", "el-macedonian", "el-pontic", "el-standard", "gu-standard", "ha-standard", "he-standard", "hi-awadhi", "hi-bengali", "hi-bhojpuri", "hi-bihari", "hi-chhattisgarhi", "hi-gujarati", "hi-haryanvi", "hi-khariboli", "hi-malvi", "hi-marathi", "hi-marwadi", "hi-punjabi", "hi-rajasthani", "hi-standard", "hi-tamil", "hi-telugu", "hu-standard", "hu-budapest", "hu-eastern", "hu-western", "hu-northern", "hu-southern", "is-standard", "id-balinese", "id-javanese", "id-standard", "id-sundanese", "ga-standard", "it-calabrese", "it-florentine", "it-genoese", "it-milanese", "it-neapolitan", "it-romanesco", "it-sicilian", "it-standard", "it-ticinese", "it-tuscan", "it-venetian", "ja-kansai", "ja-kanto", "ja-kyushu", "ja-okinawa", "ja-standard", "ja-tohoku", "jv-standard", "kn-standard", "kk-standard", "ky-standard", "ko-chungcheong", "ko-gyeongsang", "ko-hamgyong", "ko-jeolla", "ko-seoul", "ko-standard", "lv-standard", "ln-standard", "lt-standard", "lb-standard", "mk-standard", "ms-brunei", "ms-indonesian", "ms-kelantanese", "ms-malaysian", "ms-singaporean", "ms-standard", "ml-standard", "mr-standard", "ne-standard", "no-standard", "no-oslo", "no-bergen", "no-trøndersk", "no-northern", "no-sørlandsk", "ps-standard", "fa-standard", "pl-kashubian", "pl-mazovian", "pl-podhale", "pl-silesian", "pl-standard", "pt-brazilian", "pt-european", "pt-african", "pt-azorean", "pt-creole", "pt-galician", "pt-madeiran", "pa-standard", "ro-banat", "ro-bucovina", "ro-maramures", "ro-moldovan", "ro-oltenia", "ro-standard", "ro-transylvanian", "ru-moscow", "ru-saint-petersburg", "ru-standard", "sr-standard", "sd-standard", "sk-central", "sk-eastern", "sk-standard", "sk-western", "sl-standard", "so-standard", "es-latin-american", "es-peninsular", "es-andalusian", "es-argentine", "es-basque", "es-canary-islands", "es-caribbean", "es-chilean", "es-colombian", "es-cuban", "es-dominican", "es-ecuadorian", "es-galician", "es-mexican", "es-peruvian", "es-puerto-rican", "es-venezuelan", "sw-standard", "sv-gothenburg", "sv-gotland", "sv-norrland", "sv-scanian", "sv-standard", "sv-stockholm", "ta-chennai", "ta-coimbatore", "ta-madurai", "ta-salem", "ta-standard", "ta-thanjavur", "ta-tirunelveli", "te-standard", "th-standard", "tr-aegean", "tr-anatolian", "tr-black-sea", "tr-central", "tr-eastern", "tr-istanbul", "tr-southeastern", "tr-standard", "uk-kiev", "uk-standard", "ur-standard", "vi-standard", "vi-northern", "vi-central", "vi-southern", "cy-standard"
description	string	No	-	A valid string

Output

Field	Type	Description
status	string	The status of the API request. Allowed values: `"success"`, `"processing"`, `"failed"`
voice	object	The updated voice profile object.
voice.voice_id	string (uuid)	The unique identifier for the generated voice profile.
voice.voice_name	string	The name of the voice profile.
voice.description	string	A brief description of the voice's characteristics.
voice.age	string	The age category of the voice. Allowed values: `"child"`, `"teen"`, `"young-adult"`, `"early-middle-aged"`, `"late-middle-aged"`, `"senior"`
voice.gender	string	The gender of the voice. Allowed values: `"male"`, `"female"`, `"neutral"`
voice.language	string	The primary language code for the voice profile (e.g., `"en"`).
voice.accent	string	The specific accent regional variant (e.g., `"en-american"`).
voice.voice_type	string	The type of the voice profile. Allowed values: `"private"`, `"imported"`, `"public"`
voice.voice_state	string	The state of the voice profile. Allowed values: `"processing"`, `"active"`
voice.preview_url	string	The direct URL to an audio sample file for previewing the generated voice.
voice.generation_info	object	The object containing the information regarding voice profile generation.
voice.generation_info.reference_audio_urls	string[]	String array including the URLs to the input audio used for generating the audio profile.
voice.generation_info.preview_text	string	The custom text used to generate audio preview of the voice profile.
voice.created_at	string	Date and time of creation in UTC format.