Sign in

v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
bots

Update bot (partial)

Update bot fields

patch/bots/{key}

Path parameters

keystring required

The id or name of the bot to retrieve

Request body

namestring

Name of the bot

urlstring

Bot url

helpUrlstring

Url of the support documentation for the bot

ownerUrlstring

Url of the owner of the bot

activeboolean

If the bot is active

versionstring

The version of the bot. Use Semantic Versioning 2.0.0

displayNamestring

The name displayed in the bot header.

actionsobject[]

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

dataobject[]

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

Updated field

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