Zoho: Tags schemas
18 Zoho schemas with complete fields and constraints.
← Tags operations · All schemas
Delete tag by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body for a successful tag deletion. Additional keys: not allowed |
tags | array | Optional | Represents an array containing the result of the tag deletion operation. Maximum items: 1 |
tags[] | Model | Each item | Expand Delete tag by ID — response body — tags item |
Referenced models: Delete tag by ID — response body — tags item
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
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 |
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 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 get Tags — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body for a successful tag list retrieval. Additional keys: not allowed |
info | Model | Required within parent | Expand Tags — tags get Tags — response body — info |
tags | array | Required within parent | Represents an array of tag objects returned for the module. Maximum items: 484 |
tags[] | Model | Each item | Expand Tags — tags get Tags — response body — tags item |
Referenced models: Tags — tags get Tags — response body — info, Tags — tags get Tags — response body — tags item
Tags — tags get Tags — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents pagination and limit information for the tag list response. Additional keys: not allowed |
allowed_count | JSON | Required within parent | |
allowed_count (anyOf 1) | integer | Alternative | Represents the maximum number of tags allowed for the module in your plan. Format: int32 |
allowed_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of tags returned in the response. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
record_limit | JSON | Optional | |
record_limit (anyOf 1) | integer | Alternative | Represents the maximum number of records a tag can be applied to. Format: int32 |
record_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Tags — tags get Tags — response body — tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a tag object returned in the GET response, including its ID, name, color code, timestamps, and audit user details. Additional keys: not allowed |
color_code | JSON | Required within parent | |
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 | Required within parent | Expand Tags — tags get Tags — response body — tags item created by |
created_time | string | Required within parent | Represents the creation date and time of the tag. Format: date-time Maximum length: 255 |
id | string | Required within parent | Represents the unique ID of the tag. Maximum length: 255 |
modified_by | Model | Required within parent | Expand Tags — tags get Tags — response body — tags item modified by |
modified_time | string | Required within parent | Represents the last modification date and time of the tag. Format: date-time Maximum length: 255 |
name | string | Required within parent | Represents the name of the tag. Maximum length: 255 |
Referenced models: Tags — tags get Tags — response body — tags item created by, Tags — tags get Tags — response body — tags item modified by
Tags — tags get Tags — response body — tags item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the user who created the tag in the GET response. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the user who created the tag. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the user who created the tag. Maximum length: 255 |
Tags — tags get Tags — response body — tags item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the user who last modified the tag in the GET response. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the user who last modified the tag. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the user who last modified the tag. Maximum length: 255 |
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.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 |
Update tag by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body schema for the update tag operation. Additional keys: allowed |
tags | array | Required within parent | Represents an array of tag objects to update. 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
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 |
Update tag by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body returned when a tag update operation completes successfully. Additional keys: not allowed |
tags | array | Optional | Represents an array containing the result of the tag update operation. Maximum items: 1 |
tags[] | Model | Each item | Expand Delete tag by ID — response body — tags item |
Referenced models: Delete tag by ID — response body — tags item