To remove users from an account.

This API requires JWT generated by an application created only from the Bot Admin Console.
Note: This feature was introduced in ver7.1 of the platform.

Method	DELETE
Endpoint	https://{{host}}/api/public/users
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Bot Builder: Not Applicable Admin Console: User Management > User Management

 

 

Path Parameters

Parameter	Description
host	Environment URL, for example, https://bots.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":["deskkore1@gmail.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": "deskkore1@gmail.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"
              }
          }
      ]
  }