Delete Tags

Purpose

To delete a tag from a module.

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/settings/tags/{tag_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.settings.ALL
(or)
scope=ZohoBigin.settings.tags.{operation_type}

Possible operation types

ALL - Full data access
WRITE - Edit tag data
DELETE - Delete tag data

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/tags/2000000035058"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
3.0.08.0
CopiedLong tagId = 3477061000005794039L;

//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();

//Call deleteTag method that takes tag id as parameter
APIResponse < ActionHandler > response = tagsOperations.deleteTag(tagId);
Copiedpackage com.zoho.crm.api.sample.restapi.tag;
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 DeleteTags 
{
	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/settings/tags/34770617409206");
			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();
		}
	}
}
3.0.07.x
Copied//Get instance of TagsOperations Class
$tagsOperations = new TagsOperations();
//Call deleteTag method that takes tag id as parameter
$response = $tagsOperations->deleteTag($tagId);
Copied<?php

class DeleteTags
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2/settings/tags/35240335017001";
        
        $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.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
        
        $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 DeleteTags())->execute();
Copieddef delete_tags(self):
        try:
            resp = ZCRMTag.get_instance("3719520000000531002").delete()
            print(resp.details)
            print(resp.status)
            print(resp.message)
            print(resp.code)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
CopiedZCRMTag tagIns = ZCRMTag.GetInstance(3372164000001539001); //3372164000001539001 tag id
APIResponse response = tagIns.Delete();
JObject tag = response.ResponseJSON; //tag is JArray
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2/settings/tags/2000000035058"
	type: DELETE
	connection:"crm_oauth_connection"
];
info response;

Possible Errors

  • 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 ZohoBigin.settings.tags.DELETE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to delete tags
    Resolution: The user does not have permission to delete tags. 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.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to delete tags
    Resolution: The user does not have the permission to delete tags. Contact your system administrator.

  • INVALID_DATAHTTP 400

    tags not found
    Resolution: The tag ID specified in the URL is invalid. Refer to Get Tags API to get valid tag IDs.

Sample Response

Copied{
    "tags": {
        "code": "SUCCESS",
        "details": {
            "id": "2000000035058"
        },
        "message": "tags deleted successfully",
        "status": "success"
    }
}