Update Tags
Purpose
To update tags.
Request Details
Request URL
https://www.zohoapis.com/crm/v2/settings/tags?module={module_api_name}
To update a specific tag: https://www.zohoapis.com/crm/v2/settings/tags/{tag_id}?module={module_api_name}
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.settings.ALL
(or)
scope=ZohoCRM.settings.tags.{operation_type}
Possible operation types
ALL - Full data access
WRITE - Edit tag data
UPDATE - Update tag data
Parameters
- modulestring, mandatory
Specify the API name of the module such as Leads, Contacts, Accounts, Deals, etc,.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/settings/tags?module=Contacts"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@multipletagupdate.json"
CopiedString moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(UpdateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List < com.zoho.crm.api.tags.Tag > tagList = new ArrayList < com.zoho.crm.api.tags.Tag > ();
//Get instance of Tag Class
com.zoho.crm.api.tags.Tag tag1 = new com.zoho.crm.api.tags.Tag();
tag1.setId(3477061000006052001 L);
tag1.setName("tagName123");
tagList.add(tag1);
request.setTags(tagList);
//Call updateTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse < ActionHandler > response = tagsOperations.updateTags(request, paramInstance);
Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPut;
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.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class UpdateTags
{
@SuppressWarnings("deprecation")
private static void updateTags()
{
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");
uriBuilder.addParameter("module", "Leads");
HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONArray recordArray = new JSONArray();
JSONObject recordObject = new JSONObject();
recordObject.put("id", "34770617409206");
recordObject.put("name", "Chems");
recordArray.put(recordObject);
recordObject = new JSONObject();
recordObject.put("id", "34770617695014");
recordObject.put("name", "Agricultural");
recordArray.put(recordObject);
requestBody.put("tags", recordArray);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
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();
}
}
@SuppressWarnings("deprecation")
private static void updateTag()
{
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");
uriBuilder.addParameter("module", "Leads");
HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONArray recordArray = new JSONArray();
JSONObject recordObject = new JSONObject();
recordObject.put("name", "Chems");
recordArray.put(recordObject);
requestBody.put("tags", recordArray);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
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)
{
updateTags();
updateTag();
}
}
Copied//Get instance of TagsOperations Class
$tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
$request = new BodyWrapper();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(UpdateTagsParam::module(), $moduleAPIName);
//List of Tag instances
$tagList = array();
$tagClass = 'com\zoho\crm\api\tags\Tag';
//Get instance of Tag Class
$tag1 = new $tagClass();
$tag1->setId("34770614014");
$tag1->setName("tagName1");
array_push($tagList, $tag1);
$request->setTags($tagList);
//Call updateTags method that takes BodyWrapper instance and paramInstance as parameter
$response = $tagsOperations->updateTags($request, $paramInstance);
Copied<?php
class UpdateTags
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/settings/tags?";
$parameters = array();
$parameters["module"]="Leads";
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] = "PUT";
$requestBody = array();
$tagArray = array();
$tagObject = array();
$tagObject["name"]="Chems";
$tagObject["id"]="35240336015022";
$tagArray[] = $tagObject;
$requestBody["tags"] =$tagArray;
$curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
$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 UpdateTags())->execute();
Copied//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.Add(UpdateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List<API.Tags.Tag> tagList = new List<API.Tags.Tag>();
//Get instance of Tag Class
API.Tags.Tag tag1 = new API.Tags.Tag();
tag1.Id = 3477061000006052001;
tag1.Name = "tagName123";
tagList.Add(tag1);
request.Tags = tagList;
//Call updateTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse<ActionHandler> response = tagsOperations.UpdateTags(request, 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 UpdateTags
{
public static void UpdateListofTag()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/settings/tags?module=Leads");
request.Method = "PUT";
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", "34770617695014");
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 UpdateTag()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/settings/tags/3477061007409206?module=Leads");
request.Method = "PUT";
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);
}
}
}
Copied# Get instance of TagsOperations Class
tags_operations = TagsOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters of Update Tags operation
param_instance.add(UpdateTagsParam.module, module_api_name)
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Tag instances
tags_list = []
# Get instance of Tag Class
tag_1 = Tag()
# Set ID
tag_1.set_id(3409643000000661047)
# Set name
tag_1.set_name("edited-tagname")
# Add the instance to list
tags_list.append(tag_1)
# Get instance of Tag Class
tag_2 = Tag()
# Set ID
tag_2.set_id(3409643000000661048)
# Set name
tag_2.set_name("edited-tagname")
# Add the instance to list
tags_list.append(tag_2)
request.set_tags(tags_list)
# Call update_tags method that takes BodyWrapper instance and ParameterMap instance as parameter
response = tags_operations.update_tags(request, param_instance)
# Get instance of TagsOperations Class
tags_operations = TagsOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters of Update Tag operation
param_instance.add(UpdateTagParam.module, module_api_name)
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Tag instances
tags_list = []
# Get instance of Tag Class
tag_1 = Tag()
# Set name
tag_1.set_name("py- tagname")
# Add the instance to list
tags_list.append(tag_1)
request.set_tags(tags_list)
# Call update_tag method that takes BodyWrapper instance, ParameterMap instance and tag_id as parameter
response = tags_operations.update_tag(tag_id, request, param_instance)
Copieddef update_tags():
import requests
import json
url = 'http://www.zohoapis.com/crm/v2/settings/tags'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
}
parameters = {
'module': 'Leads'
}
request_body = dict()
record_list = list()
record_object_1 = {
'id': '3409643000000661014',
'name': 'Aggregates'
}
record_object_2 = {
'id': '3409643000000661013',
'name': 'modified-tag'
}
record_list.append(record_object_1)
record_list.append(record_object_2)
request_body['tags'] = record_list
response = requests.put(url=url, headers=headers, params=parameters, data=json.dumps(request_body).encode('utf-8'))
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
update_tags()
def update_tag():
import requests
import json
url = 'http://www.zohoapis.com/crm/v2/settings/tags/3409643000000661014'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
}
parameters = {
'module': 'Leads'
}
request_body = dict()
record_list = list()
record_object = {
'name': 'Chemicals'
}
record_list.append(record_object)
request_body['tags'] = record_list
response = requests.put(url=url, headers=headers, params=parameters, data=json.dumps(request_body).encode('utf-8'))
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
update_tag()
Copied//Get instance of TagsOperations Class
let tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new BodyWrapper();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Update Tags operation */
await paramInstance.add(UpdateTagsParam.MODULE, moduleAPIName);
//Array to hold Tag instances
let tagsArray = [];
//Get instance of Tag Class
let tag = new Tag();
//Set ID to tag instance
tag.setId(3409643000002993001n);
//Set name
tag.setName("edited-tagname");
//Add the instance to array
tagsArray.push(tag);
//Set the array to tags in BodyWrapper instance
request.setTags(tagsArray);
//Call updateTags method that takes BodyWrapper instance and ParameterMap instance as parameter
let response = await tagsOperations.updateTags(request, paramInstance);
Copiedasync function updateTags() {
const got = require("got");
let url = 'http://www.zohoapis.com/crm/v2/settings/tags'
let headers = {
Authorization : "Zoho-oauthtoken 1000.2280xxx.d40bxxx"
}
let parameters = {
'module': 'Leads'
}
let requestBody = {}
let recordArray = []
let recordObject1 = {
'id': '3409643000000661014',
'name': 'Aggregates'
}
let recordObject2 = {
'id': '3409643000000661013',
'name': 'modified-tag'
}
recordArray.push(recordObject1)
recordArray.push(recordObject2)
requestBody['tags'] = recordArray
let requestDetails = {
method : "PUT",
headers : headers,
searchParams : parameters,
body : JSON.stringify(requestBody),
encoding: "utf8",
throwHttpErrors : false
};
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
updateTags()
async function updateTag() {
const got = require("got");
let url = 'http://www.zohoapis.com/crm/v2/settings/tags/3409643000000661014'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let parameters = {
'module': 'Leads'
}
let requestBody = {}
let recordArray = []
let recordObject = {
'name': 'Chemicals'
}
recordArray.push(recordObject)
requestBody['tags'] = recordArray
let requestDetails = {
method : "PUT",
headers : headers,
searchParams : parameters,
body : JSON.stringify(requestBody),
encoding: "utf8",
throwHttpErrors : false
};
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
updateTag()
Copied# List to hold Tag instances
tags = []
tags_id = [3_524_033_000_003_429_018, 3_524_033_000_003_700_023]
for i in 0..1
# Get instance of Tag Class
tag = Tags::Tag.new
#Set ID
tag.id = tags_id[i]
#Set name
tag.name = tags_id[i].to_s
# Add the instance to list
tags.push(tag)
end
# Get instance of BodyWrapper Class that will contain the request body
bw = Tags::BodyWrapper.new
# Set the list to tags in BodyWrapper instance
bw.tags = tags
# Get instance of TagsOperations Class
to = Tags::TagsOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Possible parameters of Update Tags operation
pm.add(Tags::TagsOperations::UpdateTagsParam.module_1, module_api_name)
# Call update_tags method that takes BodyWrapper instance and ParameterMap instance as parameter
response = to.update_tags(pm,bw)
# List to hold Tag instances
tags = []
for i in 0..0
# Get instance of Tag Class
tag = Tags::Tag.new
#Set name
tag.name = 'sd'
# Add the instance to list
tags.push(tag)
end
# Get instance of BodyWrapper Class that will contain the request body
bw = Tags::BodyWrapper.new
# Set the list to tags in BodyWrapper instance
bw.tags = tags
# Get instance of TagsOperations Class
to = Tags::TagsOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Possible parameters of Update Tag operation
pm.add(Tags::TagsOperations::UpdateTagParam.module_1, module_api_name)
# Call update_tag method that takes BodyWrapper instance, ParameterMap instance and tag_id as parameter
response = to.update_tag(bw, pm, tag_id)
Copiedclass UpdateTags
def execute
parameters ={}
parameters["module"]="Leads";
query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
url ="https://www.zohoapis.com/crm/v2/settings/tags"
url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
url = URI(url)
req = Net::HTTP::Put.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) }
request_body = {};
tag_array = [];
tag_object = {};
tag_object["name"] = "Varisggble33";
tag_object["id"] = "3524033000000191017";
tag_array = [tag_object];
request_body["tags"] =tag_array;
request_json = request_body.to_json
req.body = request_json.to_s
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
UpdateTags.new.execute
Copied//Get instance of TagsOperations Class
let tagsOperations = new ZCRM.Tag.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Tag.Model.BodyWrapper();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Update Tags operation */
await paramInstance.add(ZCRM.Tag.Model.UpdateTagsParam.MODULE, moduleAPIName);
//Array to hold Tag instances
let tagsArray = [];
//Get instance of Tag Class
let tag = new ZCRM.Tag.Model.Tag();
//Set ID to tag instance
tag.setId(34770617973007n);
//Set name
tag.setName("edited-tagname");
//Add the instance to array
tagsArray.push(tag);
//Set the array to tags in BodyWrapper instance
request.setTags(tagsArray);
//Call updateTags method that takes BodyWrapper instance and ParameterMap instance as parameter
let response = await tagsOperations.updateTags(request, paramInstance);
Copiedvar listener = 0;
class UpdateTags {
async updateListofTag() {
var url = "https://www.zohoapis.com/crm/v2/settings/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 UpdateTags().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("module", "Leads")
var requestMethod = "PUT"
var reqBody = {"tags":[
{
"id":"35240335587006",
"name": "Variable33"
},
{
"id":"35240335591002",
"name": "Variableasd33"
}
]}
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 UpdateTags().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async updateTag() {
var url = "https://www.zohoapis.com/crm/v2/settings/tags/35240336019007"
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 UpdateTags().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("module", "Leads")
var requestMethod = "PUT"
var reqBody = {"tags":[
{
"name": "Variable33"
}
]}
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 UpdateTags().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);
}
}
})
}
}
Copiedtag1 = Map();
tag1.put("name", "chem");
tag1.put("id", "692969000000995008");
tag2 = Map();
tag2.put("name", "Agriculture");
tag2.put("id", "692969000000995002");
tags_list = List();
tags_list.add(tag1);
tags_list.add(tag2);
param = Map();
param.put("tags", tags_list);
res = invokeurl
[
url :"https://www.zohoapis.com/crm/v2/settings/tags?module=Leads"
type :PUT
parameters: param.toString()
connection:"crm_oauth_connection"
];
info res;
In the input, @multipletagupdate.json contains the sample input data.
Input JSON Keys
- idstring, mandatory for updating multiple tags
Specify the unique ID of the tag that you want to update.
Sample Input
Copied{
"tags": [
{
"id": "410888000000482039",
"name": "Chems"
},
{
"id": "410888000000482040",
"name": "Agricultural"
}
]
}
Possible Errors
- 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. - 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.settings.tags.UPDATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to update tag details
Resolution: The user does not have permission to update 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 update tags
Resolution: The user does not have the permission to update tags. Contact your system administrator. - INVALID_DATAHTTP 400
invalid data
Resolution: The input specified is incorrect. Specify a valid input. - DUPLICATE_DATAHTTP 400
duplicate data
Resolution: You have specified a duplicate value for one or more unique fields. Refer to Fields Metadata API to know the unique fields. - MANDATORY_NOT_FOUNDHTTP 400
required field not found
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields. - REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameter is missing
Resolution: 'module' parameter is missing in the request. Please specify the API name of the module. Refer to Modules API to get valid module API names.
Sample Response
Copied{
"tags": [
{
"code": "SUCCESS",
"message": "tags updated successfully",
"status": "success",
"details": {
"created_by": {
"id": "2000000030444",
"name": "Chems"
},
"created_time": "2017-03-24T11:08:23+05:30",
"id": "2000000088041",
"modified_by": {
"id": "2000000030784",
"name": "Medical"
},
"modified_time": "2017-03-24T11:08:23+05:30"
}
},
{
"code": "SUCCESS",
"message": "tags updated successfully",
"status": "success",
"details": {
"created_by": {
"id": "2000000030344",
"name": "Agricultural"
},
"created_time": "2017-03-24T11:08:23+05:30",
"id": "2000000088041",
"modified_by": {
"id": "2000000038764",
"name": "Rural"
},
"modified_time": "2017-03-24T11:08:23+05:30"
}
}
]
}