DELETE - Delete user
 

Purpose

Use this API to delete user from the organization.
 

Authorization

HeaderKeyDescription
Authorization*Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*Set to application/json.

Request URL

Method: DELETE

https://voice.zoho.com/rest/json/zv/api/users

Scope: ZohoVoice.agents.DELETE

Parameters:
 

Param Name

Data Type

Description

userids*

String

Represents the list of user IDs separated by commas.

Sample Request

Copiedcurl 'https://voice.zoho.com/rest/json/zv/api/users?userids=2069000003014001' \
  -X 'DELETE'

Sample Response - Success

Copied{
  "code": "200",
  "users": [
    {
      "userid": "4061000001164001",
      "status": "SUCCESS"
    }
  ],
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "200",
  "users": [
    {
      "agentId": "4061000001181005",
      "userid": 4061000001181001,
      "queue": {
        "queueList": [
          "NQ",
          "TESTq"
        ],
        "errorCode": "ZVT0037",
        "message": "User is configured in Queue. ",
        "status": "ERROR"
      },
      "status": "ERROR"
    }
  ],
  "status": "SUCCESS"
}