Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootRepresents a parent picklist option and its mapped child picklist values for dependency creation.
Additional keys: not allowed
actual_valuestringOptionalRepresents the actual stored value of the parent picklist option.
Maximum length: 120
display_valuestringOptionalRepresents the display label of the parent picklist option as shown in the CRM interface.
Maximum length: 120
idstringRequired within parentRepresents 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
mapsarrayRequired within parentLists the child picklist options associated with this parent picklist value.
Maximum items: 2000
maps[]objectEach itemEach object represents a child picklist option mapped to this parent value.
Additional keys: not allowed
maps[].actual_valuestringOptionalRepresents the actual stored value of the child picklist option.
Maximum length: 120
maps[].display_valuestringOptionalRepresents the display label of the child picklist option as shown in the CRM interface.
Maximum length: 120
maps[].idstringRequired within parentRepresents 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

FieldTypePresenceDescription and constraints
$objectRootRepresents the success response returned after a create, update, or delete operation.
Additional keys: not allowed
codestringRequired within parentRepresents the success code for the operation. Possible values: **SUCCESS**.

Known values: SUCCESS
detailsobjectRequired within parentContains the result details for the operation.
Additional keys: not allowed
details.idstringRequired within parentRepresents the unique identifier of the dependency the operation created, updated, or deleted.
Format: int64
messagestringRequired within parentDescribes the result of the operation.
Maximum length: 500
statusstringRequired within parentRepresents 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

FieldTypePresenceDescription and constraints
$objectRootRepresents a parent picklist option with its complete set of mapped child picklist values, as returned in GET responses.
Additional keys: not allowed
actual_valuestringRequired within parentRepresents the actual stored value of the parent picklist option.
Maximum length: 120
display_valuestringRequired within parentRepresents the display label of the parent picklist option as shown in the CRM interface.
Maximum length: 120
idstringRequired within parentRepresents the unique identifier of the parent picklist option.
Format: int64
mapsarrayRequired within parentLists the child picklist options associated with this parent picklist value.
Maximum items: 2000
maps[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents a picklist option with its unique identifier, actual value, and display label.
Additional keys: not allowed
actual_valuestringRequired within parentRepresents the actual stored value of the picklist option.
Maximum length: 120
display_valuestringRequired within parentRepresents the display label of the picklist option as shown in the CRM interface.
Maximum length: 120
idstringRequired within parentRepresents the unique identifier of the picklist option.
Format: int64

Update an existing field dependency — request body — body map dependency item child

FieldTypePresenceDescription and constraints
$objectRootRepresents a reference to a field, identified by its unique ID and API name.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the field.
Maximum length: 50
idstringRequired within parentRepresents the unique identifier of the field.
Format: int64

Update an existing field dependency — request body — body map dependency item pick list values item

FieldTypePresenceDescription and constraints
$objectRootRepresents 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_valuestringOptionalRepresents the actual stored value of the parent picklist option.
Maximum length: 120
display_valuestringOptionalRepresents the display label of the parent picklist option as shown in the CRM interface.
Maximum length: 120
idstringRequired within parentRepresents the unique identifier of the parent picklist option.
Format: int64
mapsarrayRequired within parentLists the child picklist options associated with this parent picklist value.
Maximum items: 2000
maps[]objectEach itemRepresents a child picklist option in the dependency update. Supports deletion using the **_delete** property.
Additional keys: allowed
maps[]._deletenullOptionalIndicates that this child option mapping should be deleted. Set to **null** to remove the mapping.
maps[].actual_valuestringOptionalRepresents the actual stored value of the child picklist option.
Maximum length: 120
maps[].display_valuestringOptionalRepresents the display label of the child picklist option as shown in the CRM interface.
Maximum length: 120
maps[].idstringRequired within parentRepresents the unique identifier of the child picklist option.
Format: int64

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.