Zoho: Map dependency schemas
6 Zoho schemas with complete fields and constraints.
← Map dependency operations · All schemas
Create a field dependency for a layout — request body — body map dependency item pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a parent picklist option and its mapped child picklist values for dependency creation. Additional keys: not allowed |
actual_value | string | Optional | Represents the actual stored value of the parent picklist option. Maximum length: 120 |
display_value | string | Optional | Represents the display label of the parent picklist option as shown in the CRM interface. Maximum length: 120 |
id | string | Required within parent | Represents the unique identifier of the parent picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the ID of the picklist. Format: int64 |
maps | array | Required within parent | Lists the child picklist options associated with this parent picklist value. Maximum items: 2000 |
maps[] | object | Each item | Each object represents a child picklist option mapped to this parent value. Additional keys: not allowed |
maps[].actual_value | string | Optional | Represents the actual stored value of the child picklist option. Maximum length: 120 |
maps[].display_value | string | Optional | Represents the display label of the child picklist option as shown in the CRM interface. Maximum length: 120 |
maps[].id | string | Required within parent | Represents the unique identifier of the child picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the details of the picklist. Format: int64 |
Delete a field dependency — response body — map dependency item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response returned after a create, update, or delete operation. Additional keys: not allowed |
code | string | Required within parent | Represents the success code for the operation. Possible values: **SUCCESS**. Known values: SUCCESS |
details | object | Required within parent | Contains the result details for the operation. Additional keys: not allowed |
details.id | string | Required within parent | Represents the unique identifier of the dependency the operation created, updated, or deleted. Format: int64 |
message | string | Required within parent | Describes the result of the operation. Maximum length: 500 |
status | string | Required within parent | Represents the status of the operation. Possible values: **success**. Known values: success |
Get a field dependency by ID — response body — map dependency map dependency item pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a parent picklist option with its complete set of mapped child picklist values, as returned in GET responses. Additional keys: not allowed |
actual_value | string | Required within parent | Represents the actual stored value of the parent picklist option. Maximum length: 120 |
display_value | string | Required within parent | Represents the display label of the parent picklist option as shown in the CRM interface. Maximum length: 120 |
id | string | Required within parent | Represents the unique identifier of the parent picklist option. Format: int64 |
maps | array | Required within parent | Lists the child picklist options associated with this parent picklist value. Maximum items: 2000 |
maps[] | Model | Each item | Expand Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item |
Referenced models: Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item
Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a picklist option with its unique identifier, actual value, and display label. Additional keys: not allowed |
actual_value | string | Required within parent | Represents the actual stored value of the picklist option. Maximum length: 120 |
display_value | string | Required within parent | Represents the display label of the picklist option as shown in the CRM interface. Maximum length: 120 |
id | string | Required within parent | Represents the unique identifier of the picklist option. Format: int64 |
Update an existing field dependency — request body — body map dependency item child
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to a field, identified by its unique ID and API name. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the field. Maximum length: 50 |
id | string | Required within parent | Represents the unique identifier of the field. Format: int64 |
Update an existing field dependency — request body — body map dependency item pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a parent picklist option and its mapped child picklist values for dependency updates. Supports removal of individual child mappings using the **_delete** property. Additional keys: not allowed |
actual_value | string | Optional | Represents the actual stored value of the parent picklist option. Maximum length: 120 |
display_value | string | Optional | Represents the display label of the parent picklist option as shown in the CRM interface. Maximum length: 120 |
id | string | Required within parent | Represents the unique identifier of the parent picklist option. Format: int64 |
maps | array | Required within parent | Lists the child picklist options associated with this parent picklist value. Maximum items: 2000 |
maps[] | object | Each item | Represents a child picklist option in the dependency update. Supports deletion using the **_delete** property. Additional keys: allowed |
maps[]._delete | null | Optional | Indicates that this child option mapping should be deleted. Set to **null** to remove the mapping. |
maps[].actual_value | string | Optional | Represents the actual stored value of the child picklist option. Maximum length: 120 |
maps[].display_value | string | Optional | Represents the display label of the child picklist option as shown in the CRM interface. Maximum length: 120 |
maps[].id | string | Required within parent | Represents the unique identifier of the child picklist option. Format: int64 |