younifyd
Menu

Add Tags to a Record

Add Tags to a Record

POST/{module}/{id}/actions/add_tags

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Add Tags to a Record action (under Tags).
  3. Fill in the fields below, then reference the result from later steps as {{addTagsToARecord.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.

idstringrequired

Unique identifier of the record or tag. Use the [Get Tags API](tags.yaml#$.paths./settings/tags.get) to retrieve tag IDs.

Query parameters

over_writeboolean

If true, replaces all existing tags on the record with the specified tags. If false or omitted, the specified tags are appended to the existing tags.

Request body

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

idsstring | null

JSON array string of record IDs to associate tags with. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.

One of["3060320000002538026"]

over_writeboolean | null

If true, replaces all existing tags. If false, appends tags to existing ones.

tagsarray<object>required

Array of tags to associate with 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": "[\"3060320000002538026\"]",
  "over_write": false
}

Response

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

idsstring

Record IDs that were processed

over_writeboolean

Indicates whether tags were replaced or appended

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

success_countstring

Number of records that were successfully updated

tagsstring

Root key for tags

json
{
  "ids": "string",
  "over_write": false,
  "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",
  "success_count": "string",
  "tags": "string"
}

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