Update a cloned voice

Modifies the metadata and configuration of an existing cloned voice without changing the underlying voice model. This allows updating voice information such as name, description, language settings, and custom labels for better organization and management.

Update Process:

• Validation: Verifies the voice exists and belongs to the organization
• Selective Updates: Only provided fields are updated, others remain unchanged
• Metadata Refresh: Updates timestamps and version information
• Propagation: Changes are immediately available across all voice services

Updatable Fields:

• Name: Voice identifier for display and selection
• Description: Detailed voice characteristics and usage notes
• Language: Primary language setting (affects synthesis optimization)
• Labels: Custom metadata tags for organization and filtering

Important Considerations:

• Voice Model: The actual voice characteristics and audio cannot be changed
• Provider Settings: Provider-specific configuration cannot be modified
• Active Usage: Updates do not affect ongoing calls or cached synthesis
• Organization Scope: Can only update voices owned by the organization

Language Update Impact:

• May affect synthesis quality if language doesn’t match voice training
• Pronunciation and accent optimization will use the new language setting
• Consider voice compatibility when changing language settings

Labels Management:

• Completely replaces existing labels with provided object
• To remove all labels, provide an empty object {}
• To keep existing labels, omit the labels field from the request

Common Use Cases:

• Updating voice names for better organization
• Adding descriptive information after voice testing
• Correcting language settings for better synthesis
• Managing voice categorization with custom labels
• Updating voice descriptions based on usage feedback

Best Practices:

• Use descriptive names that indicate voice characteristics
• Include usage context in descriptions (e.g., “Customer service”, “Marketing”)
• Maintain consistent labeling schemes across voices
• Document voice changes for team collaboration
• Test synthesis after language changes to ensure quality

Response Information:

• Returns the complete updated voice object
• Includes new lastUpdatedTime timestamp
• All fields reflect current state after updates