Remove Tags from Records

POST/{module}/actions/remove_tags

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Remove Tags from Records action (under Tags).
Fill in the fields below, then reference the result from later steps as {{removeTagsFromRecords.response.data}}.

Request

Path parameters

modulestringrequired

The API name of the module to perform the operation on. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.

Query parameters

modulestring

The API name of the module to perform the operation on. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.

Request body

Enter the body as JSON in the step's Body field.

idsstring | null

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"]

tagsarray<object>required

Array of tags to remove from the records (Required)

namestring | null

Tag name

modified_timestring | null

Last modification timestamp of the tag

color_codestring | null

Color code of the tag

conflict_idstring | null

ID of the tag to be merged into the master tag

json

{
  "tags": [
    {
      "name": "string",
      "modified_time": "2025-01-01T00:00:00Z",
      "color_code": "string",
      "conflict_id": "string"
    }
  ],
  "ids": "[\"3060320000002496003\"]"
}

Response

Returns 200 with an object. Read it in later steps with {{removeTagsFromRecords.response.data.<field>}}.

dataarray<object>

Array of operation results for each record

codestring

Status code of the operation

detailsobject5 fields

Nested schema for operation details in responses.

messagestring

Human-readable message about the operation result

statusstring

Status of the operation (e.g., success, error)

locked_countstring

Number of records that were locked and could not be updated

json

{
  "data": [
    {
      "code": "string",
      "details": {
        "modifiedTime": "string",
        "id": "string",
        "affected_data": null,
        "tags": [
          {
            "name": "string",
            "id": "string",
            "color_code": "string",
            "rid": "00000000-0000-0000-0000-000000000000"
          }
        ],
        "not_added_tags": [
          {
            "name": "string",
            "id": "string",
            "color_code": "string",
            "rid": "00000000-0000-0000-0000-000000000000"
          }
        ]
      },
      "message": "string",
      "status": "string"
    }
  ],
  "locked_count": "string"
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?