Skip to content

Back to API List

Remove Users from Account

To remove users from an account.

Note

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

Method DELETE
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • App Builder: Not Applicable
  • Admin Console: User Management > User Management

Path Parameters

PARAMETER DESCRIPTION
host Environment 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"/"orgUserIds":["john.doe@example.com"]
   }'

Body Parameters

PARAMETER DESCRIPTION
deleteEmailIds

or orgUserIds

The array of email or org user ids for each user whose information is to be deleted

Sample Response

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