Zoho: Modules schemas
13 Zoho schemas with complete fields and constraints.
← Modules operations · All schemas
Generate web-tab link for a module — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response containing the generated web tab link for a CRM module, with the link details available in the generate_link property. Additional keys: not allowed |
generate_link | Model | Required within parent | Expand Generate web-tab link for a module — response body — generate link |
Referenced models: Generate web-tab link for a module — response body — generate link
Generate web-tab link for a module — response body — generate link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a web tab link associated with a CRM module, including the tab identifier (id, int64), display name(name), and configured URL(web_link). Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the web tab. Format: int64 Maximum length: 20 Minimum length: 18 Pattern: \d+ |
name | string | Required within parent | Represents the display name of the web tab. Maximum length: 50 Minimum length: 3 |
web_link | string | Required within parent | Represents the URL configured for the web tab. Maximum length: 1000 |
Get module metadata by API name — request body — path
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
moduleIdentifier | JSON | Required within parent | |
moduleIdentifier (anyOf 1) | string | Alternative | Unique numeric identifier. Numeric string representation of a 64-bit positive integer. Format: int64 |
moduleIdentifier (anyOf 2) | string | Alternative | API name of the module to retrieve. Case-sensitive identifier following specific naming rules: must start with a letter, contain only alphanumeric characters and underscores, cannot have consecutive underscores, and must end with alphanumeric character. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$ |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_0a006039d025
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | User object identifying who created this custom view, containing id and name. Null for system-generated views. Additional keys: not allowed |
id | string | Required within parent | Unique numeric identifier (as string) of the CRM user who created this custom view. Format: int64 |
name | string | Required within parent | Display name of the CRM user who created this custom view. Maximum 101 characters. Maximum length: 101 |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_eeb47d537d32
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User object identifying who created this custom view, containing id and name. Null for system-generated views. Additional keys: not allowed |
id | string | Required within parent | Unique numeric identifier (as string) of the CRM user who created this custom view. Format: int64 |
name | string | Required within parent | Display name of the CRM user who created this custom view. Maximum 101 characters. Maximum length: 101 |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views criteria comparator, field, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Single filter criterion defining a field comparison condition. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator used for filtering (e.g., equal, contains, greater_than, less_than). Maximum length: 15 |
field | object | Required within parent | Field reference specifying which field to filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field to filter. Maximum length: 50 |
field.id | string | Required within parent | Unique identifier of the field. Format: int64 |
type | string | Required within parent | type of the field being filtered. Maximum length: 50 |
value | JSON | Required within parent | Filter value to compare against. Can be boolean, string, number, object, array, or null depending on field type and comparator. |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field configuration specifying which field to show and display settings. Additional keys: not allowed |
_pin | boolean | Required within parent | True when this field column is pinned in the custom view, keeping it visible during horizontal scrolling. |
api_name | string | Required within parent | API name of the field displayed as this view column. Maximum 50 characters. Maximum length: 50 |
id | string | Required within parent | Unique numeric identifier (as string) of the field displayed as this view column. Format: int64 |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference object identifying the module to which this custom view belongs, containing the module's unique identifier and API name. This is exposed only for client calls. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module this custom view belongs to. Maximum 50 characters. Maximum length: 50 |
id | string | Required within parent | Unique numeric identifier (as string) of the module this custom view belongs to. Format: int64 |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Share target with subordinates included. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the entity. Format: int64 |
name | string | Required within parent | Name of the entity (user, role, group, or territory). Maximum length: 50 |
subordinates | JSON | Required within parent | |
subordinates (anyOf 1) | boolean | Alternative | Indicates if subordinates of the specified entity are included in sharing. Known values: True |
subordinates (anyOf 2) | null | Alternative | Indicates if subordinates of the specified entity are included in sharing. Known values: True |
type | string | Required within parent | Type of entity the view is shared with (territories, roles, groups, users). Known values: territories, roles, groups, users |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Share target without subordinates. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the entity. Format: int64 |
name | string | Required within parent | Name of the entity (user, role, group, or territory). Maximum length: 50 |
subordinates | JSON | Required within parent | |
subordinates (anyOf 1) | boolean | Alternative | Indicates if subordinates are excluded from sharing. Known values: False |
subordinates (anyOf 2) | null | Alternative | Indicates if subordinates are excluded from sharing. Known values: False |
type | string | Required within parent | Type of entity the view is shared with (territories, roles, groups, users). Known values: territories, roles, groups, users |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_7f4ade2b2bbe
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field object specifying the column used to sort records in this view, containing api_name and id. Null when no sort field is configured. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field used as the sort column in this view. Maximum 50 characters. Maximum length: 50 |
id | string | Required within parent | Unique numeric identifier (as string) of the field used as the sort column in this view. Format: int64 |
Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_9fe373614add
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Field object specifying the column used to sort records in this view, containing api_name and id. Null when no sort field is configured. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field used as the sort column in this view. Maximum 50 characters. Maximum length: 50 |
id | string | Required within parent | Unique numeric identifier (as string) of the field used as the sort column in this view. Format: int64 |
Retrieve modules — response body — modules modules item arguments null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Argument object that defines a URL parameter substitution, with a name (template key) and a value (field reference expression). Additional keys: not allowed |
name | string | Required within parent | Key used in the web tab URL template to identify the substitution parameter. Maximum length: 50 |
value | string | Required within parent | Field substitution reference expression (for example, `users.recordId`) resolved at runtime for web tab URL parameter substitution. Maximum length: 100 |