Tag APIs
Tags are keywords that help you categorize your records based on their characteristics. Tags help you sort your data and find them easily when you need them.
Get Tags
Purpose
To display all the tags in an organization.
Request Details
Request URL
{api-domain}/crm/{version}/settings/tags?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 access to tags
READ - Get tag details
Parameters
- modulestring, mandatory
Specify the API name of the module such as Leads, Accounts, Deals, etc,.
- my_tagsboolean, optional
The value true displays the names of the tags created by the current user. The default value is false.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/settings/tags?module=Contacts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedString moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetTagsParam.MODULE, moduleAPIName);
//paramInstance.add(GetTagsParam.MY_TAGS, ""); //Displays the names of the tags created by the current user.
//Call getTags method that takes paramInstance as parameter
APIResponse < ResponseHandler > response = tagsOperations.getTags(paramInstance);
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.HttpGet;
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 TagAPIs
{
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("http://www.zohoapis.com/crm/v2.1/settings/tags");
uriBuilder.addParameter("module", "Leads");
uriBuilder.addParameter("my_tags", "true");
HttpUriRequest requestObj = new HttpGet(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 TagsOperations Class
$tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(GetTagsParam::module(), $moduleAPIName);
// $paramInstance->add(GetTagsParam::myTags(), ""); //Displays the names of the tags created by the current user.
//Call getTags method that takes paramInstance as parameter
$response = $tagsOperations->getTags($paramInstance);
Copied<?php
class GetTags{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "http://www.zohoapis.com/crm/v2.1/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] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
$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 GetTags())->execute();
Copied//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.Add(GetTagsParam.MODULE, moduleAPIName);
//paramInstance.Add(GetTagsParam.MY_TAGS, ""); //Displays the names of the tags created by the current user.
//Call getTags method that takes paramInstance as parameter
APIResponse<ResponseHandler> response = tagsOperations.GetTags(paramInstance);
Copiedusing System;
using System.IO;
using System.Net;
using System.Xml;
using Newtonsoft.Json;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Tag
{
public class TagAPIs
{
public static void GetTags()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("http://www.zohoapis.com/crm/v2.1/settings/tags?module=Leads&my_tags=true");
request.Method = "GET";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
string IfModifiedSince = JsonConvert.SerializeObject("2020-05-15T12:00:00+05:30");
IfModifiedSince = IfModifiedSince.Replace("\\", "");
IfModifiedSince = IfModifiedSince.Replace("\"", "");
DateTime dateConversion = XmlConvert.ToDateTime(IfModifiedSince, XmlDateTimeSerializationMode.Utc);
request.IfModifiedSince = dateConversion;
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 Get Tags operation
param_instance.add(GetTagsParam.module, module_api_name)
param_instance.add(GetTagsParam.my_tags, 'true')
# Call get_tags method that takes ParameterMap instance as parameter
response = tags_operations.get_tags(param_instance)
Copieddef get_tags():
import requests
url = 'http://www.zohoapis.com/crm/v2.1/settings/tags'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
}
parameters = {
'module': 'Leads',
'my_tags': 'true',
}
response = requests.get(url=url, headers=headers, params=parameters)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
get_tags()
Copied//Get instance of TagsOperations Class
let tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters of Get Tags operation */
await paramInstance.add(GetTagsParam.MODULE, moduleAPIName);
await paramInstance.add(GetTagsParam.MY_TAGS, "true");
//Call getTags method that takes ParameterMap instance as parameter
let response = await tagsOperations.getTags(paramInstance);
Copiedasync function getTags() {
const got = require("got");
let url = 'http://www.zohoapis.com/crm/v2.1/settings/tags'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let parameters = {
'module': 'Leads',
'my_tags': 'true',
}
let requestDetails = {
method : "GET",
headers : headers,
searchParams : parameters,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
getTags()
Copied# Get instance of TagsOperations Class
to = Tags::TagsOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Possible parameters of Get Tags operation
pm.add(Tags::TagsOperations::GetTagsParam.module_1, module_api_name)
# Call get_tags method that takes ParameterMap instance as parameter
response = to.get_tags(pm)
Copiedrequire 'net/http'
require 'json'
class GetTags
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.1/settings/tags"
url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
url = URI(url)
req = Net::HTTP::Get.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
GetTags.new.execute
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2.1/settings/tags?module=Contacts"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON keys
- created_timestring
Represents the date and time at which the tag was created.
- modified_timestring
Represents the date and time at which the tag was last modified.
- namestring
Represents the name of the current tag.
- modified_byJSON object
Represents the name and ID of the user who last modified the current tag.
- idstring
Represents the unique ID of the current tag.
- created_byJSON object
Represents the name and ID of the user who created the tag.
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.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read tag details
Resolution: The user does not have permission to read tag details. 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 read tag details
Resolution: The user does not have the permission to read tag details. Contact your system administrator. - 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": [
{
"created_by": {
"id": "2000000030444",
"name": "Construction Industry"
},
"created_time": "2017-03-24T11:08:23+05:30",
"id": "2000000039007",
"modified_by": {
"id": "2000000030444",
"name": "Chems"
},
"modified_time": "2017-03-24T11:08:23+05:30",
"name": "Chemical Industry"
}
],
"info": {
"allowed_count": 50,
"count": 1
}
}