Skip to navigation

Run a bot command

Requires a Bot Key with the corresponding management scope. Elite Keys are rejected here. apps lists up to 30 apps; status shows one app; license creates a Default-plan key; pause/resume control an app; ban/unban control a user, license or device.

Authentication

AuthorizationBearer

Account-level key with the exact resource.action permission and a supporting account plan.

Request

This endpoint expects an object.
commandenumRequired
appIdstringOptional
Application ID, required except for apps.
resourceenumOptional
Required for ban and unban.
Allowed values:
idstringOptional

Identity record ID for ban/unban.

daysstringOptionalDefaults to 30
License duration when command is license.

Response

Successful
textstring
idstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error