Zoho: Merge Tags

← Tags actions operations · Get started

Operation zoho.mergetags

Provider route: POST /crm/v8/settings/tags/{id}/actions/merge. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["tagsActions"]["mergeTags"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.tagsActions.mergeTags(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.tags_actions.merge_tags(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 19
body	Model	Optional	Expand Merge Tags — request body — body

Referenced models: Merge Tags — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Merge Tags — response body

Referenced models: Merge Tags — response body

Schemas

Merge Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response when tags are merged successfully. Additional keys: not allowed
tags	array	Optional	Array containing the merged tag details Maximum items: 1
tags[]	Model	Each item	Expand Merge Tags — response body — tags item

Referenced models: Merge Tags — response body — tags item

Merge Tags — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body schema for merging tags. Additional keys: not allowed
tags	array	Required within parent	Array containing the tag to merge (Required) Maximum items: 1
tags[]	Model	Each item	Expand Merge Tags — request body — body tags item

Referenced models: Merge Tags — request body — body tags item

Merge Tags — response body — tags item

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag details in merge response. Additional keys: not allowed
code	string	Optional	Status code of the merge operation Maximum length: 255
details	Model	Optional	Expand Merge Tags — response body — tags item details
message	string	Optional	Human-readable message about the merge result Maximum length: 255
status	string	Optional	Status of the merge operation Maximum length: 255

Referenced models: Merge Tags — response body — tags item details

Merge Tags — request body — body tags item

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag details in requests. Additional keys: not allowed
color_code	string or null	Optional	Color code of the tag Maximum length: 7
conflict_id	string or null	Optional	ID of the tag to be merged into the master tag Maximum length: 19
modified_time	string or null	Optional	Last modification timestamp of the tag Format: date-time Maximum length: 25
name	string or null	Optional	Tag name Maximum length: 25

Merge Tags — response body — tags item details

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for details in merge response. Additional keys: not allowed
color_code	JSON	Optional
color_code (anyOf 1)	string	Alternative	Color code of the tag Maximum length: 255
color_code (anyOf 2)	null	Alternative	Color code of the tag Maximum length: 255
created_by	Model	Optional	Expand Merge Tags — response body — tags item details created by
created_time	string	Optional	Creation timestamp of the tag Maximum length: 255
id	string	Optional	Unique identifier of the tag Maximum length: 255
modified_by	Model	Optional	Expand Merge Tags — response body — tags item details modified by
modified_time	string	Optional	Last modification timestamp of the tag Maximum length: 255
rid	string	Optional	Resource ID Format: uuid

Referenced models: Merge Tags — response body — tags item details created by, Merge Tags — response body — tags item details modified by

Merge Tags — response body — tags item details created by

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for created_by user details. Additional keys: not allowed
id	string	Optional	Unique identifier of the user Maximum length: 255
name	string	Optional	Name of the user who created the resource Maximum length: 255

Merge Tags — response body — tags item details modified by

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for modified_by user details. Additional keys: not allowed
id	string	Optional	Unique identifier of the user Maximum length: 255
name	string	Optional	Name of the user who last modified the resource Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.mergetags. Catalog operation: mergeTags. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source