Merge Tags

Purpose

To merge tags and put all the records under the two tags into a single tag.

Endpoints

POST /settings/tags/{tag_id}/actions/merge

Request Details

Request URL

{api-domain}/crm/{version}/settings/tags/{tag_id}/actions/merge

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/2000000035058/actions/merge"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@mergetag.json"

3.0.08.0

CopiedLong tagId = 3477061000005794039L;
String conflictId = "3477061000005803151";

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

//Get instance of MergeWrapper Class that will contain the request body
MergeWrapper request = new MergeWrapper();

//List of Tag ConflictWrapper
List < ConflictWrapper > tags = new ArrayList < ConflictWrapper > ();

//Get instance of ConflictWrapper Class
ConflictWrapper mergeTag = new ConflictWrapper();

mergeTag.setConflictId(conflictId);

tags.add(mergeTag);

request.setTags(tags);

//Call mergeTags method that takes tag and MergeWrapper instance id as parameter
APIResponse < ActionHandler > response = tagsOperations.mergeTags(tagId, request);

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 MergeTags 
{
	@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/34770617641003/actions/merge");
			HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("conflict_id", "34770617409206");
			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 MergeWrapper Class that will contain the request body
$request = new MergeWrapper();
//List of Tag ConflictWrapper
$tags = array();
//Get instance of ConflictWrapper Class
$mergeTag = new ConflictWrapper();
$mergeTag->setConflictId($conflictId);
array_push($tags, $mergeTag);
$request->setTags($tags);
//Call deleteTag method that takes MergeWrapper instance and tag id as parameter
$response = $tagsOperations->mergeTags($tagId,$request);

Copied<?php

class MergeTags
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2.1/settings/tags/3524033000005927006/actions/merge";
 
        $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["conflict_id"]="3524033000006015022";
        
        $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 MergeTags())->execute();

3.0.08.x

Copied//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of MergeWrapper Class that will contain the request body
MergeWrapper request = new MergeWrapper();
//List of Tag ConflictWrapper
List<ConflictWrapper> tags = new List<ConflictWrapper>();
//Get instance of ConflictWrapper Class
ConflictWrapper mergeTag = new ConflictWrapper();
mergeTag.ConflictId = conflictId;
tags.Add(mergeTag);
request.Tags = tags;
//Call mergeTags method that takes tagId and MergeWrapper instance as parameter
APIResponse<ActionHandler> response = tagsOperations.MergeTags(tagId, request);

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 MergeTags
    {
        public static void MergeTag()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/tags/34770617695026/actions/merge");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.8e20XXXXXXXXXXXXXXXXXXXXXX8e6.801bXXXXXXXXXXXXXXXXXXXXd53";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("conflict_id", "34770617695014");
            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 MergeWrapper Class that will contain the request body
request = MergeWrapper()
# Array to hold ConflictWrapper instances
tag_list = []
# Get instance of ConflictWrapper Class
conflict_wrapper = ConflictWrapper()
# Set the conflict ID
conflict_wrapper.set_conflict_id(conflict_id)
# Add the instance to list
tag_list.append(conflict_wrapper)
# Set the list to tags in BodyWrapper instance
request.set_tags(tag_list)
# Call merge_tags method that takes MergeWrapper instance and tag_id as parameter
response = tags_operations.merge_tags(tag_id, request)

Copieddef merge_tags():
    import requests
    import json

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

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

    request_body = dict()
    record_list = list()

    record_object = {
        'conflict_id': '3409643000000661187'
    }

    record_list.append(record_object)

    request_body['tags'] = record_list

    response = requests.post(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))

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

        print(response.json())

merge_tags()

1.0.010.x

Copied//Get instance of TagsOperations Class
let tagsOperations = new TagsOperations();
//Get instance of MergeWrapper Class that will contain the request body
let request = new MergeWrapper();
//Array to hold ConflictWrapper instances
let tagsArray = [];
//Get instance of ConflictWrapper Class
let conflictWrapper = new ConflictWrapper();
//Set the conflict ID
conflictWrapper.setConflictId(conflictId);
//Add the instance to array
tagsArray.push(conflictWrapper);
//Set the array to tags in BodyWrapper instance
request.setTags(tagsArray);
//Call mergeTags method that takes MergeWrapper instance and tag id as parameter
let response = await tagsOperations.mergeTags(tagId, request);

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

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

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

    let requestBody = {}
    let recordArray = []

    let recordObject = {
        'conflict_id': '3409643000000661187'
    }

    recordArray.push(recordObject)

    requestBody['tags'] = recordArray

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

2.1.0

Copied# Get instance of TagsOperations Class
to = Tags::TagsOperations.new
# Array to hold ConflictWrapper instances
tags = []
# Get instance of ConflictWrapper Class
merge_tag = Tags::ConflictWrapper.new
# Set the conflict ID
merge_tag.conflict_id = conflict_id
# Add the instance to list
tags.push(merge_tag)
# Get instance of MergeWrapper Class that will contain the request body
mw = Tags::MergeWrapper.new
# Set the list to tags in BodyWrapper instance
mw.tags = tags
# Call merge_tags method that takes MergeWrapper instance and tag_id as parameter
response = to.merge_tags(tag_id,mw)

Copiedrequire 'net/http'
require 'json'

class MergeTags
    def execute
        url ="https://www.zohoapis.com/crm/v2.1/settings/tags/3524033000006025021/actions/merge"
        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["conflict_id"] = "3524033000006019007";      
        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

MergeTags.new.execute

Copiedtag1 = Map();
tag1.put("conflict_id", "692969000000995002");

tags_list = List();
tags_list.add(tag1);

param = Map();
param.put("tags", tags_list);

res = invokeurl
[
	url :"https://www.zohoapis.com/crm/v2.1/settings/tags/692969000000995001/actions/merge"
	type :POST
	parameters: param.toString()
	connection:"crm_oauth_connection"
];
info res;

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

Input JSON Keys

conflict_idstring, mandatory
Specify the unique ID of the tag which you want to merge.

Sample Input

Copied{
    "tags": [
       {
            "conflict_id": "2000000039012"
        }
    ]
}

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.settings.tags.CREATE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to merge tags
Resolution: The user does not have permission to merge 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 merge tags
Resolution: The user does not have the permission to merge tags. Contact your system administrator.
INVALID_DATAHTTP 400
invalid data
Resolution: The input specified is incorrect. Specify a valid input
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.

Sample Response

Copied{
    "tags": [
       {
            "code": "SUCCESS",
            "message": "tags merged successfully",
            "status": "success",
            "details": {
                "created_by": {
                    "id": "2000000030874",
                    "name": "Medical"
                },
                "created_time": "2017-03-24T11:08:23+05:30",
                "id": "2000000088041",
                "modified_by": {
                    "id": "2000000030444",
                    "name": "Chems"
                },
                "modified_time": "2017-03-24T11:08:23+05:30"
            }
        }
    ]
}