Create New Tags

Purpose

To create new tags.

Endpoints

POST /settings/tags?module={module_api_name}

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 data access
WRITE - Edit tag data
CREATE - Create tag data

Sample Request

Curl Java PHP Csharp Python Node JS Ruby Deluge

Copiedcurl "https://www.zohoapis.com/crm/v2.1/settings/tags?module=Contacts"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@createnewtag.json"

3.0.08.0

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(CreateTagsParam.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.setName("tagName");

tagList.add(tag1);

request.setTags(tagList);

//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse < ActionHandler > response = tagsOperations.createTags(request, 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.HttpEntityEnclosingRequestBase;
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.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 CreateNewTags 
{
	@SuppressWarnings("deprecation")
	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.1/settings/tags");
			uriBuilder.addParameter("module", "Leads");
			HttpUriRequest requestObj = new HttpPost(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);
			recordObject = new JSONObject();
			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();
		}
	}
}

4.0.04.x

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(CreateTagsParam::module(), $moduleAPIName);
//List of Tag instances
$tagList = array();
$tagClass = 'com\zoho\crm\api\tags\Tag';
//Get instance of Tag Class
$tag1 = new $tagClass();
$tag1->setName("tagName");
array_push($tagList, $tag1);
$request->setTags($tagList);
//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
$response = $tagsOperations->createTags($request, $paramInstance);

Copied<?php

class CreateTags
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://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] = "POST";
        $requestBody = array();
        $tagArray = array();
        $tagObject = array();
        $tagObject["name"]="Chems";
       
        $tagArray[] = $tagObject;
        $requestBody["tags"] =$tagArray;
        $curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
        $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 CreateTags())->execute();

3.0.08.x

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(CreateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List<Com.Zoho.Crm.API.Tags.Tag> tagList = new List<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.Name = "tagName001";
tagList.Add(tag1);
request.Tags = tagList;
//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse<ActionHandler> response = tagsOperations.CreateTags(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 CreateNewTags
    {
        public static void CreateTags()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/tags?module=Leads");
            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);
            recordObject = new JObject();
            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);
        }
    }
}

3.0.03.x.x

Copied# Get instance of TagsOperations Class
tags_operations = TagsOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters of Create Tags operation
param_instance.add(CreateTagsParam.module, module_api_name)
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Tag instances
tags_list = []
for i in range(0,3):
    # Get instance of Tag Class
    tag = ZCRMTag()
    # Set Name to tag
    tag.set_name("python-tag" + str(i))
    # Add the Tag instance to list
    tags_list.append(tag)
# Set the list to tags in BodyWrapper instance
request.set_tags(tags_list)
# Call create_tags method that takes BodyWrapper instance and ParameterMap instance as parameter
response = tags_operations.create_tags(request, param_instance)

Copieddef create_tags():
    import requests
    import json

    url = 'https://www.zohoapis.com/crm/v2.1/settings/tags'

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

    parameters = {
        'module': 'Leads'
    }

    request_body = dict()
    record_list = list()

    record_object_1 = {
        'name': 'Chems'
    }

    record_object_2 = {
        'name': 'Agricultural'
    }

    record_list.append(record_object_1)
    record_list.append(record_object_2)

    request_body['tags'] = record_list

    response = requests.post(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())

create_tags()

1.0.010.x

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 Create Tags operation */
await paramInstance.add(CreateTagsParam.MODULE, moduleAPIName);
//Array to hold Tag instances
let tagsArray = [];
for (let index = 0; index < 3; index++) {
    //Get instance of Tag Class
    let tag = new Tag();
    //Set Name to tag
    tag.setName("tag" + index.toString());
    //Add the Tag instance to array
    tagsArray.push(tag);
}
//Set the array to tags in BodyWrapper instance
request.setTags(tagsArray);
//Call createTags method that takes BodyWrapper instance and ParameterMap instance as parameter
let response = await tagsOperations.createTags(request, paramInstance);

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

    let url = 'https://www.zohoapis.com/crm/v2.1/settings/tags'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.2280xxx.d40bxxx"
    }

    let parameters = {
        'module': 'Leads'
    }

    let requestBody = {}
    let recordArray = []

    let recordObject1 = {
        'name': 'Chems'
    }

    let recordObject2 = {
        'name': 'Agricultural'
    }

    recordArray.push(recordObject1)
    recordArray.push(recordObject2)

    requestBody['tags'] = recordArray

    let requestDetails = {
        method : "POST",
        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);
    } 
}

createTags()

2.1.0

Copied# List to hold Tag instances
tags = []
(3..4).each do |i|
  # Get instance of Tag Class
  tag = Tags::Tag.new
  # Set Name to tag
  tag.name = i.to_s
  # Add the Tag 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 Create Tags operation
pm.add(Tags::TagsOperations::CreateTagsParam.module_1, module_api_name)
# Call create_tags method that takes BodyWrapper instance and ParameterMap instance as parameter
response = to.create_tags(pm,bw)

Copiedrequire 'net/http'
require 'json'

class CreateTags
    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::Post.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) }
       
        request_body = {};
        tag_array = [];
        tag_object = {};
        tag_object["name"] = "asd";      
        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

CreateTags.new.execute

Copiedtag1 = Map();
tag1.put("name", "Chems");

tag2 = Map();
tag2.put("name", "Agriculture");

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.1/settings/tags?module=Leads"
	type :POST
	parameters: param.toString()
	connection:"crm_oauth_connection"
];
info res;

In the input, @createnewtag.json contains the sample input data.

Parameters

modulestring, mandatory
Specify the API name of the module such as Leads, Accounts, Deals, etc,.

Input JSON Keys

namestring, mandatory
Specify the name of the tag that you want to create.

Sample Input

Copied{
    "tags": [
       {
            "name": "Chems"
        },
       {
            "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.CREATE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to create tags
Resolution: The user does not have permission to create 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 create tags
Resolution: The user does not have the permission to create tags. Contact your system administrator.
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.
INVALID_DATAHTTP 400
Invalid Data
Resolution: One of the input keys is specified in the wrong format. Refer to Input JSON keys section above and specify valid input.

Sample Response

Copied{
    "tags": [
       {
            "code": "SUCCESS",
            "message": "tags created successfully",
            "status": "success",
            "details": {
                "created_by": {
                    "id": "2000000030444",
                    "name": "Chems"
                },
                "created_time": "2017-03-24T11:08:23+05:30",
                "id": "2000000088041",
                "modified_by": {
                    "id": "2000000030444",
                    "name": "Pharmaceutical"
                },
                "modified_time": "2017-03-24T11:08:23+05:30"
            }
        },
       {
            "code": "SUCCESS",
            "message": "tags created successfully",
            "status": "success",
            "details": {
                "created_by": {
                    "id": "2000000030564",
                    "name": "Agricultural"
                },
                "created_time": "2017-03-24T11:08:23+06:30",
                "id": "2000000088041",
                "modified_by": {
                    "id": "2000000030564",
                    "name": "Leather"
                },
                "modified_time": "2017-03-24T11:08:23+06:30"
            }
        }
    ]
}