Zoho: Update tag by ID

← Tags operations · Get started

Operation zoho.updatetagbyid

Provider route: PUT /crm/v8/settings/tags/{id}. 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["tags"]["updateTagById"]>[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.tags.updateTagById(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.update_tag_by_id(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	Tag ID Maximum length: 255
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 100
query.id	string	Required within parent	Maximum length: 19
body	Model	Optional	Expand Update tag by ID — request body — body

Referenced models: Update tag by ID — 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 Update tag by ID — response body

Referenced models: Update tag by ID — response body

Schemas

Update tag by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body returned when a tag update operation completes successfully. Additional keys: not allowed
tags	array	Optional	Represents an array containing the result of the tag update operation. Maximum items: 1
tags[]	Model	Each item	Expand Delete tag by ID — response body — tags item

Referenced models: Delete tag by ID — response body — tags item

Update tag by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for the update tag operation. Additional keys: allowed
tags	array	Required within parent	Represents an array of tag objects to update. The array can contain a maximum of one item. Maximum items: 1
tags[]	Model	Each item	Expand Update tag by ID — request body — body tags item

Referenced models: Update tag by ID — request body — body tags item

Delete tag by ID — response body — tags item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a tag operation result object returned in the response. Additional keys: not allowed
code	string	Optional	Represents the operation result code for the tag. Maximum length: 255
details	Model	Optional	Expand Delete tag by ID — response body — tags item details
message	string	Optional	Represents the operation result message for the tag. Maximum length: 255
status	string	Optional	Represents the status of the tag operation. Maximum length: 255

Referenced models: Delete tag by ID — response body — tags item details

Update tag by ID — request body — body tags item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for creating or updating a tag. Additional keys: allowed
color_code	string or null	Optional	Specify the hex color code for the tag, such as **#FF0000**. Set to null to remove the assigned color. Maximum length: 7
name	string	Required within parent	Specify the name of the tag. The maximum allowed length is 26 characters. Maximum length: 26

Delete tag by ID — response body — tags item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the detailed metadata of the tag, including timestamps, the tag name, color code, and the users who created and last modified it. Additional keys: not allowed
color_code	JSON	Optional
color_code (anyOf 1)	string	Alternative	Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned. Maximum length: 255
color_code (anyOf 2)	null	Alternative	Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned. Maximum length: 255
created_by	Model	Optional	Expand Delete tag by ID — response body — tags item details created by
created_time	string	Optional	Represents the creation date and time of the tag. Format: date-time Maximum length: 255
id	string	Optional	Represents the unique ID of the tag. Maximum length: 255
modified_by	Model	Optional	Expand Delete tag by ID — response body — tags item details modified by
modified_time	string	Optional	Represents the last modification date and time of the tag. Format: date-time Maximum length: 255
name	string	Optional	Represents the name of the tag. Maximum length: 255

Referenced models: Delete tag by ID — response body — tags item details created by, Delete tag by ID — response body — tags item details modified by

Delete tag by ID — response body — tags item details created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the tag. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the user who created the tag. Maximum length: 255
name	string	Optional	Represents the display name of the user who created the tag. Maximum length: 255

Delete tag by ID — response body — tags item details modified by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the tag. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the user who last modified the tag. Maximum length: 255
name	string	Optional	Represents the display name of the user who last modified the tag. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.updatetagbyid. Catalog operation: updateTagById. 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