Skip to main content
POST
/
v1
/
voice-agents
/
voice-dictionaries
/
toggle-activation
Toggle Voice Dictionary Activation
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/voice-dictionaries/toggle-activation \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dictionaryId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
  "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "isActive": true
}
'
{
  "success": true,
  "message": "Voice dictionary activation toggled successfully",
  "messageKey": "VoiceDictionaryActivationToggledSuccessfully"
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
​
dictionaryId
string<uuid>
required

UUID of the voice dictionary.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

​
voiceAgentId
string<uuid>
required

UUID of the voice agent.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

​
isActive
boolean
required

Activation status.

Example:

true

Response

Successful response

​
success
boolean
Example:

true

​
message
string
Example:

"Voice dictionary activation toggled successfully"

​
messageKey
string
Example:

"VoiceDictionaryActivationToggledSuccessfully"