Skip to main content

Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Back to API List To add users to an account. Prerequisite: Before using this API, go to Automation AI > App Settings > Target Audience and select Enterprise Users. Then publish the app to enable user invitations.
This API requires a JWT generated by an application created only from the Admin Console.
FieldValue
MethodPOST
Endpointhttps://{{host}}/api/public/users
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeApp Builder: Not Applicable; Admin Console: User Management > User Management

​
Path Parameters

ParameterDescription
hostEnvironment URL, for example, https://platform.kore.ai.

​
Sample Request

curl -X POST \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "john.doe@example.com",
                "orgUserId": "org assigned user id",
                "firstName": "john",
                "lastName": "doe",
                "companyName": "company_name",
                "dept": "dept"
            },
            "groups": [
                "e-06b41cdd-7678-5394-b958-40ca5662xxxx"
            ],
            "roles": [
                {
                    "roleId": "5d9d8db30d54920a8df1xxxx",
                    "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb74xxxx"
                }
            ],
            "canCreateBot": true,
            "isDeveloper": true
        }
    ]
}'

​
Body Parameters

ParameterRequiredDescription
usersArray of user details.
userInfo.emailIdRequiredEmail ID of the user being added.
userInfo.orgUserIdOptionalOrganization-assigned user ID.
userInfo.firstNameOptionalFirst name of the user.
userInfo.lastNameOptionalLast name of the user.
userInfo.companyNameOptionalCompany of the user.
userInfo.deptOptionalDepartment of the user.
userInfo.companyContactPhoneOptionalCompany contact phone.
userInfo.worknumberOptionalWork number.
userInfo.streetOptionalStreet address.
userInfo.suiteNoOptionalSuite number.
userInfo.cityOptionalCity.
userInfo.zipOptionalZIP code.
userInfo.stateOptionalState.
userInfo.countryOptionalCountry.
groupsOptionalArray of group IDs to which the user should belong.
rolesOptionalArray of roleId-botId combinations defining the user’s role on each bot.
assignBotTasksOptionalArray of agents to assign to the user.
canCreateBotOptionalWhether the user can create agents. Default: true.
isDeveloperOptionalWhether the user has App Builder access. Default: true.
sendEmailOptionalWhether to send an activation email to the user. Default: true.

​
Sample Response

Success: 
{
    "msg": "Users are created Successfully"
}
Failure: 
{
    "failedUserDetails": [
        {
            "userInfo": {
                "emailId": "jane.doe@example.com",
                "firstName": "jane",
                "status": "failure",
                "reason": {
                    "errors": [
                        {
                            "msg": "INVALID_EMAIL",
                            "code": 400
                        }
                    ]
                }
            }
        }
    ]
}