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 Removes users from an account.
This API requires a JWT generated by an application created only from the Admin Console.
PropertyValue
MethodDELETE
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 DELETE \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
     "deleteEmailIds": ["john.doe@example.com"]
   }'

​
Body Parameters

ParameterDescription
deleteEmailIds or orgUserIdsArray of email addresses or org user IDs for users to remove.

​
Sample Response

Success: 
{
    "msg": "Users are removed Successfully"
}
Failure: 
{
   "failedUserDetails": [
    {
        "emailId": "john.doe@example.com",
        "reason": {
            "statusCode": 400,
            "status": 400,
            "customCode": 400,
            "errors": [
                {
                    "msg": "Unauthorized to perform this activity",
                    "code": 400
                }
            ],
            "message": "Unauthorized to perform this activity",
            "name": "BadRequest"
        }
    }
    ]
}