Activate or Deactivate Salesforce Agentforce Agent using REST API

Activate or Deactivate Salesforce Agentforce Agent using REST API

Managing your Salesforce agents just got a whole lot easier. Whether you’re scaling operations or temporarily pausing access, you can now activate or deactivate Agentforce Agents seamlessly using a RESTful API call. No more navigating complex UI steps — just one powerful POST request is all it takes!

POST request to the following endpoint can be used to enable or disable the Salesforce Agentforce Agent using REST API.

Endpoint:

https://{YOUR_ORG_DOMAIN}.my.salesforce.com/services/data/v63.0/connect/bot-versions/{BOT_VERSION_ID}/activation

Params:

To Activate, pass status parameter as Active.

To Deactivate, pass status parameter as Inactive.

Header:

In the Header, pass Authorization as key and for the value use Bearer space the Access Token.

Salesforce Article:

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_bot_version_activation.htm

You can use the following SOQL to query the BotVersion object/entity.

SELECT Id, DeveloperName, BotDefinition.MasterLabel, 
BotDefinition.DeveloperName, BotDefinition.Type
FROM BotVersion

Salesforce Article:

https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_botdefinition.htm

Leave a Reply