Remove a voice
Give up an added voice and free its allowance slot. Any agent still speaking with it is moved to the default voice FIRST, and the response says how many were, so read reassignedAgents before reporting the removal as clean. incompleteAgents counts the ones that could not be moved and still need attention. Only a voice this agency added can be removed; a shared voice is not yours to remove.
Required API key scope: voices:write.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Path Parameters
The voice id as the speech provider knows it: the id used when the voice was added.
1Response
Voice removed.
The library after the removal, plus what had to be moved off the voice.
x >= 00
x >= 05
x >= 05
Agents that were speaking with this voice and have been moved to the default one. Reported so the caller can say so rather than leaving it to be discovered on the next call.
x >= 02
Agents that could NOT be moved. The removal still succeeded; this is the only signal that one of them still needs attention, so treat a non-zero value as work to do rather than noise.
x >= 00
