Remove Users from Account

Back to API List

Removes users from an account.

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

Property	Value
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": ["[e-mail]"],
     "includeMeta": true
   }'

Body Parameters

Parameter	Description
deleteEmailIds or orgUserIds	Array of email addresses or org user IDs for users to remove.
includeMeta	Optional	Set to true for encrypted response. Default: False.

Sample Response

Success:

{
    "msg": "Users are removed Successfully",
    "moreAvailable": true,
    "total": 10
}

Failure:

{
   "failedUserDetails": [
    {
        "emailId": "[e-mail]",
        "reason": {
            "statusCode": 400,
            "status": 400,
            "customCode": 400,
            "errors": [
                {
                    "msg": "Unauthorized to perform this activity",
                    "code": 400
                }
            ],
            "message": "Unauthorized to perform this activity",
            "name": "BadRequest"
        }
    }
    ]
}

Response Parameters

Parameter	Type	Description
moreAvailable	Boolean	Indicates if more records are available for retrieval.
total	Optional	The total count of available records.