Zoho: Tags actions schemas
33 Zoho schemas with complete fields and constraints.
← Tags actions operations · All schemas
Add Tags to Records — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body schema for adding tags to records. Additional keys: not allowed |
ids | string or null | Optional | 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"] Maximum length: 102 |
over_write | boolean or null | Optional | If true, replaces all existing tags. If false, appends tags to existing ones. |
tags | array | Required within parent | Array of tags to associate with the records (Required) Maximum items: 3 |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response when tags are associated successfully to records. 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 |
ids | string | Optional | Record IDs that were processed Maximum length: 102 |
locked_count | string | Optional | Number of records that were locked and could not be updated Maximum length: 255 |
over_write | boolean | Optional | Indicates whether tags were replaced or appended |
success_count | string | Optional | Number of records that were successfully updated Maximum length: 255 |
tags | string | Optional | Root key for tags Maximum length: 255 |
Referenced models: Add Tags to Records — response body — data 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
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 |
Get Tag Records Count — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response for tag records count API. Additional keys: not allowed |
configured_areas | Model | Optional | Expand Get Tag Records Count — response body — configured areas |
count | string | Required within parent | Total count of records associated with the tag Maximum length: 255 |
Referenced models: Get Tag Records Count — response body — configured areas
Get Tag Records Count — response body — configured areas
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for configured_areas in records count response. Additional keys: not allowed |
custom_view | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas custom view |
workflow_tagActionRecords | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records |
Referenced models: Get Tag Records Count — response body — configured areas custom view, Get Tag Records Count — response body — configured areas workflow tag Action Records
Get Tag Records Count — response body — configured areas custom view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for custom_view configurations. Additional keys: not allowed |
cvids | array | Required within parent | List of custom view IDs Maximum items: 0 |
cvids[] | JSON | Each item | |
cvmodules | array | Required within parent | List of modules with custom views Maximum items: 0 |
cvmodules[] | JSON | Each item | |
cvnames | array | Required within parent | List of custom view names Maximum items: 0 |
cvnames[] | JSON | Each item | |
inaccessible_custom_view_present | boolean | Required within parent | Indicates whether inaccessible custom views exist |
Get Tag Records Count — response body — configured areas workflow tag Action Records
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for workflow tag action records. Additional keys: not allowed |
Blueprint | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested |
Orchestration | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested |
Workflow | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested, Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested, Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested
Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for AddTags action configurations. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the AddTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the AddTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the AddTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for rules within workflow, blueprint, or orchestration configurations. Additional keys: not allowed |
execution_type | string | Required within parent | Execution type of the rule (e.g., instant, schedule) Maximum length: 255 |
id | string | Required within parent | Unique identifier of the rule Maximum length: 255 |
module | string | Required within parent | Module associated with the rule Maximum length: 255 |
name | string | Required within parent | Name of the rule Maximum length: 255 |
source | JSON | Required within parent | |
source (anyOf 1) | integer | Alternative | Source identifier for the rule Format: int32 |
source (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subtype | string | Required within parent | Rule subtype identifier Maximum length: 255 |
subtype_id | string | Required within parent | Unique identifier of the rule subtype Maximum length: 255 |
subtype_name | string | Required within parent | Name of the rule subtype Maximum length: 255 |
Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Remove Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for RemoveTags action configurations. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the RemoveTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the RemoveTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the RemoveTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed |
AddTags | array | Required within parent | AddTags configurations Maximum items: 1 |
AddTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item |
RemoveTags | array | Required within parent | RemoveTags configurations Maximum items: 1 |
RemoveTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Remove Tags item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Remove Tags item
Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for Blueprint configurations. Additional keys: not allowed |
3060320000000666022 | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1 |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1
Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for AddTags action configurations. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the AddTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the AddTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the AddTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for rules with detailed properties. Additional keys: not allowed |
execution_type | string | Required within parent | Execution type of the rule Maximum length: 255 |
id | string | Required within parent | Unique identifier of the rule Maximum length: 255 |
module | string | Required within parent | Module associated with the rule Maximum length: 255 |
name | string | Required within parent | Name of the rule Maximum length: 255 |
source | JSON | Required within parent | |
source (anyOf 1) | integer | Alternative | Source identifier for the rule Format: int32 |
source (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Required within parent | Status of the rule (e.g., Active) Maximum length: 255 |
subtype | string | Required within parent | Rule subtype identifier Maximum length: 255 |
subtype_id | string | Required within parent | Unique identifier of the rule subtype Maximum length: 255 |
subtype_name | string | Required within parent | Name of the rule subtype Maximum length: 255 |
Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Remove Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for RemoveTags action configurations. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the RemoveTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the RemoveTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the RemoveTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed |
AddTags | array | Required within parent | AddTags configurations Maximum items: 1 |
AddTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item |
RemoveTags | array | Required within parent | RemoveTags configurations Maximum items: 1 |
RemoveTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Remove Tags item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Remove Tags item
Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for Orchestration configurations. Additional keys: not allowed |
3060320000000666022 | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested
Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for AddTags action configurations with simplified rules. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the AddTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the AddTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the AddTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for rules with simplified structure. Additional keys: not allowed |
execution_type | string | Required within parent | Execution type of the rule Maximum length: 255 |
id | string | Required within parent | Unique identifier of the rule Maximum length: 255 |
module | string | Required within parent | Module associated with the rule Maximum length: 255 |
name | string | Required within parent | Name of the rule Maximum length: 255 |
source | JSON | Required within parent | |
source (anyOf 1) | integer | Alternative | Source identifier for the rule Format: int32 |
source (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subtype | string | Required within parent | Rule subtype identifier Maximum length: 255 |
subtype_id | string | Required within parent | Unique identifier of the rule subtype Maximum length: 255 |
Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Remove Tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for RemoveTags action configurations with simplified rules. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the RemoveTags configuration Maximum length: 255 |
name | string | Required within parent | Name of the RemoveTags configuration Maximum length: 255 |
rules | array | Required within parent | Rules associated with the RemoveTags configuration Maximum items: 1 |
rules[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item rules item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item rules item
Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed |
AddTags | array | Required within parent | AddTags configurations Maximum items: 3 |
AddTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item |
RemoveTags | array | Required within parent | RemoveTags configurations Maximum items: 2 |
RemoveTags[] | Model | Each item | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Remove Tags item |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Remove Tags item
Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for Workflow configurations. Additional keys: not allowed |
3060320000000666022 | Model | Required within parent | Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2 |
Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2
Merge Tags — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body schema for merging tags. Additional keys: not allowed |
tags | array | Required within parent | Array containing the tag to merge (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
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 |
Merge Tags — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response when tags are merged successfully. Additional keys: not allowed |
tags | array | Optional | Array containing the merged tag details Maximum items: 1 |
tags[] | Model | Each item | Expand Merge Tags — response body — tags item |
Referenced models: Merge Tags — response body — tags item
Merge Tags — response body — tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for tag details in merge response. Additional keys: not allowed |
code | string | Optional | Status code of the merge operation Maximum length: 255 |
details | Model | Optional | Expand Merge Tags — response body — tags item details |
message | string | Optional | Human-readable message about the merge result Maximum length: 255 |
status | string | Optional | Status of the merge operation Maximum length: 255 |
Referenced models: Merge Tags — response body — tags item details
Merge Tags — response body — tags item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for details in merge response. 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 |
created_by | Model | Optional | Expand Merge Tags — response body — tags item details created by |
created_time | string | Optional | Creation timestamp of the tag Maximum length: 255 |
id | string | Optional | Unique identifier of the tag Maximum length: 255 |
modified_by | Model | Optional | Expand Merge Tags — response body — tags item details modified by |
modified_time | string | Optional | Last modification timestamp of the tag Maximum length: 255 |
rid | string | Optional | Resource ID Format: uuid |
Referenced models: Merge Tags — response body — tags item details created by, Merge Tags — response body — tags item details modified by
Merge Tags — response body — tags item details created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for created_by user details. Additional keys: not allowed |
id | string | Optional | Unique identifier of the user Maximum length: 255 |
name | string | Optional | Name of the user who created the resource Maximum length: 255 |
Merge Tags — response body — tags item details modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for modified_by user details. Additional keys: not allowed |
id | string | Optional | Unique identifier of the user Maximum length: 255 |
name | string | Optional | Name of the user who last modified the resource Maximum length: 255 |
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
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