Zoho: Features schemas
9 Zoho schemas with complete fields and constraints.
← Features operations · All schemas
Features — response body — features, info features item components null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single component of the feature, including its API name, per-module support status, and usage limit details. Additional keys: allowed |
api_name | string | Required within parent | Represents the API name of the component within the feature. Always returned in the response. Maximum length: 255 |
details | JSON | Required within parent | |
details (anyOf 1) | Model | Alternative | Expand Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607 |
details (anyOf 2) | Model | Alternative | Expand Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b |
feature_label | string | Required within parent | Represents the display label of the component for presentation in the CRM interface. Always returned in the response. Maximum length: 255 |
module_supported | boolean | Required within parent | Indicates whether the component is supported for the specified module. Possible values: true - The component is supported for the module. false - The component is not supported for the module. Always returned in the response. |
Referenced models: Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b, Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607
Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents theused count of the feature |
used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents theused count of the feature |
used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Features — response body — features, info features item details available count, limits, used count limits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the maximum usage limits for the feature, including the absolute total limit and the edition-level ceiling. Additional keys: not allowed |
edition_limit | JSON | Optional | |
edition_limit (anyOf 1) | integer | Alternative | Represents the maximum count for the feature allowed by the current subscription edition. Format: int32 |
edition_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the absolute maximum count for the feature across all editions. Always returned in the response. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Specific Feature — response body — features features item components null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single component of the feature, including its API name, per-module support status, and usage limit details. Additional keys: allowed |
api_name | string | Required within parent | Represents the API name of the component within the feature. Always returned in the response. Maximum length: 255 |
details | JSON | Required within parent | |
details (anyOf 1) | Model | Alternative | Expand Specific Feature — response body — features features item components null item details limits, used count — shared_details_0d73da01879d |
details (anyOf 2) | Model | Alternative | Expand Specific Feature — response body — features features item components null item details limits, used count — shared_details_8103a2c6d685 |
feature_label | string | Required within parent | Represents the display label of the component for presentation in the CRM interface. Always returned in the response. Maximum length: 255 |
module_supported | boolean | Required within parent | Indicates whether the component is supported for the specified module. Possible values: true - The component is supported for the module. false - The component is not supported for the module. Always returned in the response. |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count — shared_details_0d73da01879d, Specific Feature — response body — features features item components null item details limits, used count — shared_details_8103a2c6d685
Specific Feature — response body — features features item components null item details limits, used count limits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the usage limits configured for the component. Always returned in the response. Additional keys: allowed |
edition_limit | JSON | Optional | |
edition_limit (anyOf 1) | integer | Alternative | Represents the maximum count for the component allowed by the current subscription edition. Format: int32 |
edition_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the absolute maximum count for the component, independent of the subscription edition. Always returned in the response. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Specific Feature — response body — features features item components null item details limits, used count — shared_details_0d73da01879d
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents the current usage counts for the component. |
used_count (anyOf 1) | object | Alternative | Represents the total count of component instances currently in use. Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Specific Feature — response body — features features item components null item details limits, used count — shared_details_8103a2c6d685
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents the current usage counts for the component. |
used_count (anyOf 1) | object | Alternative | Represents the total count of component instances currently in use. Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Specific Feature — response body — features features item details available count, limits, used count limits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the maximum usage limits for the feature, including the absolute total limit and the edition-level ceiling. Always returned in the response. Additional keys: not allowed |
edition_limit | JSON | Optional | |
edition_limit (anyOf 1) | integer | Alternative | Represents the maximum count for the feature allowed by the current subscription edition. Format: int32 |
edition_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the absolute maximum count for the feature across all editions. Always returned in the response. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |