Add Tags to Records

Purpose

To add tags to records.

Endpoints

POST /{module_api_name}/actions/add_tags?ids={entity_id1}&tag_names={tag1},{tag2}

POST {module_api_name}/{record_id}/actions/add_tags?tag_names={tag1},{tag2}

Request Details

Request URL

https://www.zohoapis.com/crm/v2/{module_api_name}/actions/add_tags?ids={entity_id1}&tag_names={tag1},{tag2}

To add tags to specific records:
https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}/actions/add_tags?tag_names={tag1},{tag2}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Activities

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom

Possible operation types

ALL - Full access to the record
WRITE - Edit records in the module
CREATE - Create records in the module

Parameters

tag_namesstring, optional
Specify the names of the tags to be added.
over_writeboolean, optional
Specify if the existing tags are to be overwritten. Default value is false.
idsstring, mandatory when adding tags to multiple records
Specify the unique ID of the record.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/Contacts/actions/add_tags?ids=1234567890,123456789&tag_names=From Email,High Priority&over_write=true"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

3.0.08.0

CopiedString moduleAPIName = "Leads";
ArrayList<Long> recordIds = new ArrayList<Long>(Arrays.asList(3477061000005623115L, 3477061000006114067L));
ArrayList<String> tagNames = new ArrayList<String>(Arrays.asList("addtag1,addtag12"));

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

//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();

for (String tagName: tagNames) {
    paramInstance.add(AddTagsToMultipleRecordsParam.TAG_NAMES, tagName);
}

for (Long recordId: recordIds) {
    paramInstance.add(AddTagsToMultipleRecordsParam.IDS, recordId);
}

paramInstance.add(AddTagsToMultipleRecordsParam.OVER_WRITE, "false");

//Call addTagsToMultipleRecords method that takes moduleAPIName, paramInstance as parameter
APIResponse < RecordActionHandler > response = tagsOperations.addTagsToMultipleRecords(moduleAPIName, paramInstance);

Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
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 AddTagstoRecords 
{
	private static void addTagstoRecords()
	{
		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/Leads/actions/add_tags");
			uriBuilder.addParameter("ids", "34770617753001,34770617736020");
			uriBuilder.addParameter("tag_names", "Leads");
			uriBuilder.addParameter("over_write", "true");
			HttpUriRequest requestObj = new HttpPost(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();
		}
	}
	private static void addTagstoRecord()
	{
		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/Leads/34770617753001/actions/add_tags");
			uriBuilder.addParameter("tag_names", "Leads1");
			uriBuilder.addParameter("over_write", "true");
			HttpUriRequest requestObj = new HttpPost(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();
		}
	}
	public static void main(String[] args) 
	{
		addTagstoRecords();
		addTagstoRecord();
	}
}

3.0.07.x

Copied//Get instance of TagsOperations Class
tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
foreach($tagNames as $tagName)
{
       $paramInstance->add(AddTagsToMultipleRecordsParam::tagNames(), $tagName);
}
foreach($recordIds as $recordId)
{
        $paramInstance->add(AddTagsToMultipleRecordsParam::ids(), $recordId);
}
$paramInstance->add(AddTagsToMultipleRecordsParam::overWrite(), "false");
//Call addTagsToMultipleRecords method that takes paramInstance, moduleAPIName as parameter
$response = $tagsOperations->addTagsToMultipleRecords($moduleAPIName,$paramInstance);

Copied<?php

class AddTagsToRecord
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2/Leads/actions/add_tags?";
        $parameters = array();
        $parameters["ids"]="35240335495065";
        $parameters["tag_names"]="Leads";
        $parameters["over_write"]="true";
        
        foreach ($parameters as $key=>$value){
            $url =$url.$key."=".$value."&";
        }
        $curl_options[CURLOPT_URL] =$url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "POST";
      
        $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 AddTagsToRecord())->execute();

3.0.08.x

Copied//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
foreach(string tagName in tagNames)
{
    paramInstance.Add(AddTagsToRecordParam.TAG_NAMES, tagName);
}
paramInstance.Add(AddTagsToRecordParam.OVER_WRITE, "false");
//Call AddTagsToRecord method that takes recordId, moduleAPIName and paramInstance as parameter
APIResponse<RecordActionHandler> response = tagsOperations.AddTagsToRecord(recordId, moduleAPIName, paramInstance);

Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json.Linq;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Tag
{
    public class AddTagstoRecords
    {
        public static void TagstoRecords()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/Leads/actions/add_tags?ids=34770617753001,34770617736020&tag_names=tagname1");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("id", "34770617409206");
            recordObject.Add("name", "Chems");
            recordArray.Add(recordObject);
            recordObject = new JObject();
            recordObject.Add("id", "3477067695014");
            recordObject.Add("name", "Agricultural");
            recordArray.Add(recordObject);
            requestBody.Add("tags", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            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);
        }
        public static void AddTagstoRecord()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/Leads/34770617753001/actions/add_tags?tag_names=tagname1");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("name", "Chems");
            recordArray.Add(recordObject);
            requestBody.Add("tags", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            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);
        }
    }
}

3.0.03.x.x

Copied# Get instance of TagsOperations Class
tags_operations = TagsOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Add Tags to Record operation
for tag_name in tag_names:
    param_instance.add(AddTagsToRecordParam.tag_names, tag_name)
param_instance.add(AddTagsToRecordParam.over_write, 'false')
# Call add_tags_to_record method that takes ParameterMap instance, module_api_name and record_id as parameter
response = tags_operations.add_tags_to_record(record_id, module_api_name, param_instance)



# Get instance of TagsOperations Class
tags_operations = TagsOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Add Tags To Multiple Records operation
for record_id in record_ids:
    param_instance.add(AddTagsToMultipleRecordsParam.ids, record_id)
for tag_name in tag_names:
    param_instance.add(AddTagsToMultipleRecordsParam.tag_names, tag_name)
param_instance.add(AddTagsToMultipleRecordsParam.over_write, 'false')
# Call add_tags_to_multiple_records method that takes ParameterMap instance and module_api_name as parameter
response = tags_operations.add_tags_to_multiple_records(module_api_name, param_instance)

Copieddef add_tags_to_records():
    import requests

    url = 'https://www.zohoapis.com/crm/v2/Leads/actions/add_tags'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    parameters = {
        'ids': '3409643000002982027,3409643000002882015',
        'tag_names': 'Q1,Q2',
        'over_write': 'true'
    }

    response = requests.post(url=url, headers=headers, params=parameters)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

add_tags_to_records()


def add_tags_to_record():
    import requests

    url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002982027/actions/add_tags'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    parameters = {
        'tag_names': 'Q1,Q2',
        'over_write': 'true'
    }

    response = requests.post(url=url, headers=headers, params=parameters)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

add_tags_to_record()

1.0.010.x

Copied//Get instance of TagsOperations Class
let tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Add Tags To Multiple Records operation */
for(let recordId of recordIds) {
    await paramInstance.add(AddTagsToMultipleRecordsParam.IDS, recordId);
}
await paramInstance.add(AddTagsToMultipleRecordsParam.TAG_NAMES, tagNames.toString());
await paramInstance.add(AddTagsToMultipleRecordsParam.OVER_WRITE, "false");
//Call addTagsToMultipleRecords method that takes ParameterMap instance and moduleAPIName as parameter
let response = await tagsOperations.addTagsToMultipleRecords(moduleAPIName, paramInstance);

Copiedasync function addTagsToRecord() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2/Leads/34096432982027/actions/add_tags'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let parameters = {
        'tag_names': 'Q1,Q2',
        'over_write': 'true'
    }

    let requestDetails = {
        method : "POST",
        headers : headers,
        searchParams : parameters,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}

addTagsToRecord()

2.02.x.x

Copied# Get instance of TagsOperations Class
to = Tags::TagsOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Possible parameters for Add Tags To Multiple Records operation
tag_names.each do |tag_name|
  pm.add(Tags::TagsOperations::AddTagsToMultipleRecordsParam.tag_names, tag_name)
end
record_ids.each do |record_id|
  pm.add(Tags::TagsOperations::AddTagsToMultipleRecordsParam.ids, record_id)
end
pm.add(Tags::TagsOperations::AddTagsToRecordParam.over_write, 'true')
# Call add_tags_to_multiple_records method that takes ParameterMap instance and module_api_name as parameter
response = to.add_tags_to_multiple_records(module_api_name,pm)

Copiedclass AddTagsToRecord
    def execute
        parameters ={}
        parameters["ids"]="3524033000005495065";
        parameters["tag_names"]="Leads";
        parameters["over_write"]="true";
        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
        url ="https://www.zohoapis.com/crm/v2/Leads/actions/add_tags"
        url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
        url = URI(url)
        req = Net::HTTP::Post.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
        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

AddTagsToRecord.new.execute

1.0.0ES6

Copied//Get instance of TagsOperations Class
let tagsOperations = new ZCRM.Tag.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Add Tags To Multiple Records operation */
for(let recordId of recordIds) {
    await paramInstance.add(ZCRM.Tag.Model.AddTagsToMultipleRecordsParam.IDS, recordId);
}
await paramInstance.add(ZCRM.Tag.Model.AddTagsToMultipleRecordsParam.TAG_NAMES, tagNames.toString());
await paramInstance.add(ZCRM.Tag.Model.AddTagsToMultipleRecordsParam.OVER_WRITE, "false");
//Call addTagsToMultipleRecords method that takes ParameterMap instance and moduleAPIName as parameter
let response = await tagsOperations.addTagsToMultipleRecords(moduleAPIName, paramInstance);

Copiedvar listener = 0;
class AddTagstoRecords {

	async addTagstoRecords() {
        var url = "https://www.zohoapis.com/crm/v2/Leads/actions/add_tags"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new AddTagstoRecords().getToken(token)
		headers.set('Authorization',"Zoho-oauthtoken " + accesstoken)
		parameters.set("ids", "35240336189014")
		parameters.set("tag_names", "Leadsdsds")
		parameters.set("over_write", "true");
        var requestMethod = "POST"
		var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new AddTagstoRecords().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
    }

	async addTagstoRecord()	{
		var url = "https://www.zohoapis.com/crm/v2/Leads/35240336189014/actions/add_tags"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new AddTagstoRecords().getToken(token)
		headers.set('Authorization',"Zoho-oauthtoken " + accesstoken)
		parameters.set("tag_names", "Lsdaseads")
		parameters.set("over_write", "true");
        var requestMethod = "POST"
		var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new AddTagstoRecords().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}

    async getToken(token) {

        if(listener == 0) {

            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){

                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }

        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }

            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }

    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}

Copiedresponse = invokeurl
[
url :"https://www.zohoapis.com/crm/v2/Leads/actions/add_tags?ids=692969000000968004,692969000000981055&tag_names=Chems,Agriculture"
	type :POST
	connection:"crm_oauth_connection"
];
info response;

Show full

Show less

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 ZohoCRM.modules.{module_name}.WRITE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to update records
Resolution: The user does not have permission to add tags to the 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.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to add tags
Resolution: The user does not have the permission to add tags to the records. Contact your system administrator.
INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.
INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
PATTERN_NOT_MATCHEDHTTP 400
Please check whether the input values are correct
Resolution: The value specified for one of the parameters is incorrect. Refer to parameters section above and specify valid parameter values.

Sample Response

Copied{
    "data": [
       {
            "code": "FAILURE",
            "details": {
                "id": "2445013000000402006"
            },
            "message": "tags not updated successfully",
            "status": "error"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "2445013000000141005",
                "tags": [
                    "From Email",
                    "High Priority"
                ]
            },
            "message": "tags updated successfully",
            "status": "success"
        }
    ],
    "wf_scheduler": "false",
    "success_count": "1"
}

Top

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People