Skip to main content
POST
/
v1
/
voice-agents
/
web-tool
/
toggle-activation
Toggle activation of a web tool for a voice agent.
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/web-tool/toggle-activation \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "webToolId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "isActive": true
}
'
{
  "success": false,
  "message": "Web tool activated successfully!"
}

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
​
voiceAgentId
string
required

The voice agent ID to toggle the activation of the web tool on.

Example:

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

​
webToolId
string
required

The web tool ID to toggle the activation of.

Example:

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

​
isActive
boolean
default:true

The value of isActive to toggle the activation of the web tool. True to activate, false to deactivate. Defaults to true.

Example:

true

Response

Successful response

​
success
boolean
default:false
​
message
enum<string>
default:success
Available options:
Web tool activated successfully!,
Web tool deactivated successfully!
Example:

"Web tool activated successfully!"