TRtryhamsa

Toggle activation of a knowledge base item for a voice agent.

post/v1/voice-agents/knowledge-base/toggle-activation

Request

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

Request body

voiceAgentIdstring required

The voice agent ID to toggle the activation of the knowledge base item on.

knowledgeBaseItemIdstring required

The knowledge base item ID to toggle the activation of.

isActiveboolean

The value of isActive to toggle the activation of the knowledge base item. True to activate, false to deactivate. Defaults to true.

Example request

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

Response

Successful response

successboolean
messagestring
messageKeystring

Example response

{
  "message": "Item activated successfully!",
  "messageKey": "ItemActivatedSuccessfully"
}

Changes

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