Changelogs
We regularly enhance Zoho CRM APIs with new features to suit your evolving business requirements. The following changelogs detail all significant changes introduced in version 8 of Zoho CRM APIs.
Navigating code samples:
- Newly introduced keys are highlighted in green.
- Updated existing keys are shown in orange.
- Removed keys appear in red.
If an API or feature is in Early Access, you can contact support@zohocrm.com to request access.
Version 8
The Zoho CRM APIs with updates specific to V8 are listed below.
- From V8, you can create multi-select lookup and multi-user lookup fields in a module using the POST - Create Custom Fields API.
The field metadata response structure for the multi-select and multi-user lookup field types has been changed.
Multi-select lookup field metadata response:
Multi-user lookup field metadata response:
- Use the PATCH - Update Custom Fields API to convert a local picklist field to a global picklist field and vice versa.
- From V8, you can update the reference_value key for options in the "Stage" picklist field of the Deals module using the PATCH - Update Custom Field API. Until V7, you could only read the reference_value key. This support is currently in the Early Access stage.
- The "type" key has been added to the "Stage" picklist field's options in the Deals module in the GET - Fields Metadata API. This key represents whether the option is used or unused. This support is currently in the Early Access stage.
- You can now add external fields in Calls Module using Create Custom Fields API.
- The From Number and To Number fields are automatically enabled by the system in the Calls module when the telephony extension is integrated, and they will appear in the Fields Metadata API. By default, these fields should be enabled using the PUT - Calls Preferences API introduced in Zoho CRM API Version 8.
You can now create rollup summary fields using Create Custom Fields API. This support is currently in the Early Access stage.
The keys dynamic, stop_compute_conditionally, and stop_compute_expression have been added to the formula JSON object. You can now add auto refresh formula fields using Create Custom Fields API. This support is currently in the Early Access stage.
- You can now track the history of picklist fields using the POST - Create Custom Fields API.
- The "actions_allowed" JSON object key under the "sections" JSON array, introduced in V8, represents whether the set of actions (actions displayed in the following picture) can be performed in the section.
- The section API name's format has been changed. For example, "api_name": "Lead Information" to "api_name": "Lead_Information__s". Spaces between words have been replaced with underscores(_).
- From V8, you can update the reference_value key for options in the "Stage" picklist field of the Deals module using the PATCH - Update Layout API. Until V7, the reference_value key was read-only. This enhancement is currently available under Early Access.
- The "type" key has been added to the "Stage" picklist field's options in the Deals module in the GET - Layouts Metadata API. This key indicates whether the option is used or unused.
The keys dynamic, stop_compute_conditionally, and stop_compute_expression have been added to the formula JSON object to support dynamic formula fields in the Layouts Metadata API.
- From V8, the reference_value key for options has been introduced.
- The "actual_value" key is unmodifiable. You cannot specify a value for the "actual_value" during global picklist creation or updates. By default, the system assigns the value of the "display_value" key to the "actual_value", from V8.
- The "associated_fields_count" parameter has been introduced to display the count of a global picklist's association with fields.
- From V8, you can remove a manager from the territory by setting the manager key to null in Update Territories API.
- From V8 onwards, the "equals" operator behaviour will apply, except for the picklist field type.
The "timezone" key has been introduced in the "Business Hours API" from V8.
