Toggle activation of a web tool for a voice agent.

post/v1/voice-agents/web-tool/toggle-activation

Request

  • Base URL
    https://api.tryhamsa.com
  • URL
    https://api.tryhamsa.com/v1/voice-agents/web-tool/toggle-activation
  • Auth
    API key in header Authorization

Request body

voiceAgentIdstring required

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

webToolIdstring required

The web tool ID to toggle the activation of.

isActiveboolean

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

Example request

{
  "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "webToolId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "isActive": true
}

Response

Successful response

successboolean
message'Web tool activated successfully!' | 'Web tool deactivated successfully!'

Example response

{
  "message": "Web tool activated successfully!"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.