Merge Tags

Purpose

Combine or merge two different tags into a single one.

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

ZohoCRM.settings.ALL
(or)
ZohoCRM.settings.tags.{operation_type}

Possible operation types

ALL - Full data access
WRITE - Edit tag data
CREATE - Create tag data

Sample Request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/tags/2000000035058/actions/merge"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@mergetag.json"

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/v8/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

conflict_idstring, mandatory
Specify the unique ID of the tag which you want to merge. Use the Get the List of Tags API to retrieve the tag IDs.

Note

When a tag is merged, the associated records will be updated with the new tag. For example, if Tag A is merged into Tag B, all records previously linked to Tag A will now display Tag B.

Sample Input

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

Possible Errors

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 the Endpoints section.
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.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.tags.CREATE scope. Create a new client with valid scope. Refer to the Scope section.
NO_PERMISSIONHTTP 403
Permission denied to merge tags
Resolution: The user does not have permission to merge tags. Contact your system administrator.
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 the Request URL section.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

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