SAsalesforce
bots

Upgrade bot (full)

Changed on

This route is used to update all the fields in a bot and to load in a new UI

put/bots/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/bots/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the bot to retrieve

Request body multipart/form-data

namestring

The unique readable name for the bot

activeboolean

Flag for if a bot is active with communication

urlstring

The URL of the bot server

helpUrlstring

The URL of the support documentation

ownerUrlstring

The URL of the owner of the bot

versionstring

The version of the bot. Use Semantic Versioning 2.0.0

displayNamestring

The name displayed in the bot header.

uistring binary

The zipped HTML and Javascript needed to run the UI of the bot

actionsstring[]

Array of objects that contain the name of actions a bot can take and an array of parameters needed for that action

datastring[]

Array of objects that contain the name of data on a bot

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns the updated bot.

idstring

The UUID for the bot

namestring

The unique readable name for the bot

urlstring

The URL of the bot server

activeboolean

Flag for if a bot is active with communication

actionsobject[]

A list of actions that a bot can perform

dataobject[]

A list of data that a bot can provide

installedBystring

The user who installed the bot

Changes

  • v170ecf0e334ceRevision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status