Delete User
Purpose
To delete a user from your organization.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/users/{user_id}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.users.{operation_type}
Possible operation types
ALL - Full access to users
DELETE - Delete user data
You can delete only one user per request.
Refer to Get User API to obtain the record ID of the user.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/users/554023000000691003"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedLong userId = 3477061000005817002L;
//Get instance of UsersOperations Class
UsersOperations usersOperations = new UsersOperations();
//Call deleteUser method that takes userId as parameter
APIResponse < ActionHandler > response = usersOperations.deleteUser(userId);
Copiedpackage com.zoho.crm.api.sample.restapi.users;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class DeleteUser
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/users/34770617745001");
HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of UsersOperations Class
$usersOperations = new UsersOperations();
//Call deleteUser method that takes userId as parameter
$response = $usersOperations->deleteUser($userId);
Copied<?php
class DeleteUser
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/users/3524033000006015001";
$curl_options[CURLOPT_URL] = $url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "DELETE";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.f62XXXXXXXXXXXXa8302a293.0af14ceXXXXXXXXX4ee827beb";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new DeleteUser())->execute();
Copied//Get instance of UsersOperations Class
UsersOperations usersOperations = new UsersOperations();
//Call DeleteUser method that takes userId as parameter
APIResponse<ActionHandler> response = usersOperations.DeleteUser(userId);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Users
{
public class DeleteUser
{
public static void Delete()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/users/34770617848011");
request.Method = "DELETE";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}
Copied# Get instance of UsersOperations Class
users_operations = UsersOperations()
# Call delete_user method that takes user_id as parameter
response = users_operations.delete_user(user_id)
Copieddef delete_user():
import requests
url = 'https://www.zohoapis.com/crm/v2/users/3409643000000302042'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
response = requests.delete(url=url, headers=headers)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
delete_user()
Copied//Get instance of UsersOperations Class
let usersOperations = new UsersOperations();
//Call deleteUser method that takes userId as parameter
let response = await usersOperations.deleteUser(userId);
Copiedasync function deleteUser() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2/users/3409643000000302042'
let headers = {
Authorization : "Zoho-oauthtoken 1000.354df3680XXXXXXXXXXXXX3.aae0efXXXXXXXXXXXXXXXXXX9"
}
let requestDetails = {
method : "DELETE",
headers : headers,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
deleteUser()
Copied# Get instance of UsersOperations Class
uo = Users::UsersOperations.new
# Call delete_user method that takes user_id as parameter
response = uo.delete_user(user_id)
Copiedrequire 'net/http'
require 'json'
class DeleteUser
def execute
url = URI( "https://www.zohoapis.com/crm/v2/users/3524033000006015001")
req = Net::HTTP::Delete.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
headers&.each { |key, value| req.add_field(key, value) }
response=http.request(req)
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
print response.body
end
end
end
DeleteUser.new.execute
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2.1/users/554023000000691003"
type: DELETE
connection:"crm_oauth_connection"
];
info response;
Possible Errors
- INVALID_DATAHTTP 400
the_id_given_seems_to_be_invalid
Resolution: The record ID of the user you want to delete is invalid. Refer to Get Users API to get valid record IDs. - INVALID_REQUESTHTTP 400
Primary contact cannot be deleted
Resolution: You cannot delete the primary contact of your organization. - ID_ALREADY_DELETEDHTTP 400
User is already deleted
Resolution: The user you want to delete is already deleted. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to delete users
Resolution: The user does not have the permission to delete users. Contact your system administrator. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.users.DELETE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to delete
Resolution: The user does not have permission to delete user records. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
Sample Response
Copied{
"users": [
{
"code": "SUCCESS",
"details": {},
"message": "User deleted",
"status": "success"
}
]
}