Zoho: Remove Tags from a Record

← Tags actions operations · Get started

Operation zoho.postremovetagswithid

Provider route: POST /crm/v8/{module}/{id}/actions/remove_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["tagsActions"]["postRemoveTagsWithId"]>[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.postRemoveTagsWithId(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.post_remove_tags_with_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.module	string	Required within parent	Maximum length: 100
path.id	string	Required within parent	Maximum length: 19
body	Model	Optional	Expand Remove Tags from Records — request body — body

Referenced models: Remove Tags from Records — 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 Remove Tags from Records — response body

Referenced models: Remove Tags from Records — response body

Schemas

Remove Tags from Records — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response when tags are removed from records successfully. Additional keys: not allowed
data	array	Optional	Array of operation results for each record Maximum items: 20
data[]	Model	Each item	Expand Add Tags to Records — response body — data item
locked_count	string	Optional	Number of records that were locked and could not be updated Maximum length: 255

Referenced models: Add Tags to Records — response body — data item

Remove Tags from Records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body schema for removing tags from records. Additional keys: not allowed
ids	string or null	Optional	JSON array string of record IDs to remove tags from. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs. One of: ["3060320000002496003"] Maximum length: 99
tags	array	Required within parent	Array of tags to remove from the records (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

Add Tags to Records — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for data in operation responses. Additional keys: not allowed
code	string	Optional	Status code of the operation Maximum length: 255
details	Model	Optional	Expand Add Tags to Records — response body — data item details
message	string	Optional	Human-readable message about the operation result Maximum length: 255
status	string	Optional	Status of the operation (e.g., success, error) Maximum length: 255

Referenced models: Add Tags to Records — response body — data 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

Add Tags to Records — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for operation details in responses. Additional keys: not allowed
affected_data	null	Optional	Affected data in the operation
id	string	Optional	Unique identifier of the record Maximum length: 255
modifiedTime	string	Optional	Last modified time of the record Maximum length: 255
not_added_tags	array	Optional	Tags that were not added to the record Maximum items: 10
not_added_tags[]	Model	Each item	Expand Add Tags to Records — response body — data item details tags item
tags	array	Optional	Tags associated with the record Maximum items: 10
tags[]	Model	Each item	Expand Add Tags to Records — response body — data item details tags item

Referenced models: Add Tags to Records — response body — data item details tags item

Add Tags to Records — response body — data item details tags item

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag details in responses. 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
id	string	Optional	Unique identifier of the tag Maximum length: 255
name	string	Optional	Tag name Maximum length: 255
rid	string	Optional	Resource ID Format: uuid

Policy, approvals and errors

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