Skip to content

Assign Bot Roles API

To assign a bot role to a set of users in a specific bot.

Note

This API requires JWT generated by an application created only from the Bot Admin Console.

Method POST
Endpoint https://{{host}}/api/public/btroles/assignments/
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Role Management

Path Parameters

PARAMETER REQUIRED/OPTIONAL DESCRIPTION
host Required Environment URL, for example, https://bots.kore.ai

Sample Request

curl -X POST 'https://{{host}}/api/public/btroles/assignments/' \
-H 'Content-Type: application/json' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-d '[{
"roleId":"5bee8fv6729d35741e05aba4",
"botId":"{{botId}}",
"addUsers":[""],
"removeUsers":[""],
"addGroups": ["G2"],
"removeGroups":[""]
}]'

Body Parameters

PARAMETER REQUIRED/OPTIONAL DESCRIPTION
roleId Required The ID of the bot role to assign the users or groups.
botId Required The ID of the bot in which to assign the bot roles
addUsers or addOrgUserIds Optional The list of usernames or org user ids for whom to assign the bot role
removeUsers or removeOrgUserIds Optional The list of usernames or org user ids for whom to remove the bot role
addGroups Optional The list of group names for whom to assign the bot role
removeGroups Optional The list of group names for whom to remove the bot role

Sample Response

[
    {
        "status": "success "
    }
]