Skip to main content
Version: v2

BotScope

Bot scope. Defines which spaces the bot can operate in. For type=PUB no additional fields are required; the bot can be invited to any workspace of any organization. For type=ORG an organizationId is required; the bot can be invited to any workspace of the organization it was created in. For type=WS a workspaceId is required; the bot cannot be invited to any workspace.

typeBotScopeType (string)required

Bot scope type

Possible values: [pub, org, ws]

Example: org
organizationIdstring

Organization identifier (required for type=ORG)

Example: AIQffAsGi8
workspaceIdstring

Workspace identifier (required for type=WS)

Example: BIQffAsGi9
BotScope
{
"type": "org",
"organizationId": "AIQffAsGi8",
"workspaceId": "BIQffAsGi9"
}