Zoho: Tags — tags create Tags

Zoho tags.createTags: arguments, response, policy and SDK examples.

Operation zoho.createtags

Provider route: POST /crm/v8/settings/tags. 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"]["createTags"]>[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.createTags(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.create_tags(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Required within parent	Additional keys: not allowed
`query.module`	string	Required within parent	Maximum length: 100
`body`	Model	Optional	Expand Tags — tags create Tags — request body — body

Referenced models: Tags — tags create 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
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Tags — tags create Tags — response body — tags
`$ (anyOf 2)`	object	Alternative	Represents a multi-status response containing the operation result for each tag in the request. Additional keys: not allowed
`$ (anyOf 2).tags`	array	Required within parent	Represents an array of tag operation result objects. Each item indicates whether the operation succeeded or contains the failure reason. Maximum items: 200 Minimum items: 2
`$ (anyOf 2).tags[]`	JSON	Each item	Represents a single tag operation result, which can be a success or failure item.
`$ (anyOf 2).tags[] (anyOf 1)`	Model	Alternative	Expand Tags — tags create Tags — response body — tags tags item code, details, message, status
`$ (anyOf 2).tags[] (anyOf 2)`	Model	Alternative	Expand Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error

Referenced models: Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error, Tags — tags create Tags — response body — tags, Tags — tags create Tags — response body — tags tags item code, details, message, status

Schemas

Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents an error response returned when a tag with the same name already exists in the module. Additional keys: not allowed
`code`	string	Required within parent	Represents the error code DUPLICATE_DATA. Known values: DUPLICATE_DATA
`details`	Model	Required within parent	Expand Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error details
`message`	string	Required within parent	Represents the error message describing the duplicate data condition. Known values: duplicate data
`status`	string	Required within parent	Represents the status of the error response. The value is always error. Known values: error

Referenced models: Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error details

Tags — tags create Tags — response body — tags

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the response body for a successful tag creation. Additional keys: not allowed
`tags`	array	Optional	Represents an array containing the result of the tag creation operation. Maximum items: 20
`tags[]`	Model	Each item	Expand Delete tag by ID — response body — tags item

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

Tags — tags create Tags — response body — tags tags item code, details, message, status

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a single tag operation result item in a multi-status response. Additional keys: not allowed
`code`	string	Optional	Represents the operation result code for the tag item. 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 item. Maximum length: 255
`status`	string	Optional	Represents the operation result status for the tag item. Maximum length: 255

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

Tags — tags create Tags — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the request body schema for the create tag operation. Additional keys: not allowed
`tags`	array	Required within parent	Represents an array of tag objects to create. 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

Tags — tags.createTags — response body — tags / tags / item / code: DUPLICATE DATA, message: duplicate data, status: error details

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the error details object containing validation information. Additional keys: not allowed
`api_name`	string	Required within parent	Represents the API name of the field that caused the duplicate data error. Maximum length: 255
`id`	string	Optional	Represents the ID of the duplicate tag record. Maximum length: 255
`json_path`	string	Required within parent	Represents the JSON path of the field that contains the duplicate value. Maximum length: 1000

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

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

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 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.createtags. Catalog operation: createTags. 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

Report an issue with this page