Beam Help
Get help now

How-to · Zoho CRM

How to update custom fields with Deluge functions in Zoho CRM

Deluge is Zoho CRM's scripting language that lets you automate field updates and complex data operations programmatically. You can use Deluge functions to modify custom fields on records, validate data before saving, and trigger updates across related modules.


Why this matters


Custom field updates via Deluge are essential when you need to automate data changes that go beyond standard workflows, sync data between modules, or enforce business logic that the UI alone cannot handle. This approach is especially useful during data migrations, bulk operations, or when integrating Zoho CRM with external systems.


Step-by-step


Step 1. Access the Deluge editor in Zoho CRM.


Navigate to your Zoho CRM workspace and open the automation section where custom functions are managed. Deluge is the in-house scripting language available across Zoho products for performing operations like API calls, database queries, and data manipulations [3].


Step 2. Write a function to target the custom field.


Create a Deluge function that references the custom field by its API name. You can find the API name by right-clicking on the field in your CRM module and selecting the option to view field details. Use the correct field identifier (metaApiName or inputApiName) to ensure the system recognizes the field you want to update [2].


Step 3. Use the appropriate Deluge syntax to update the field value.


Structure your script to assign a new value to the custom field. The exact syntax depends on whether you are updating a single record, multiple records, or pulling data from related modules. For example, if you need to update a date field from one module to another, you may need to retrieve the source value first, then apply it to the target field [5].


Step 4. Test the function with sample data.


Before deploying to production, run your Deluge function on a test record to verify that the custom field updates correctly. Check that the value appears in the field and that no validation errors occur. If you encounter a "PATTERNNOTMATCHED" error, double-check that you are using the correct field API name [2].


Step 5. Integrate the function into your workflow or automation rule.


Once tested, trigger the Deluge function from a workflow rule, button action, or scheduled task. This ensures the custom field update runs automatically when the specified conditions are met, rather than requiring manual execution each time [4].


Common pitfalls


Field API names are case-sensitive and must match exactly as they appear in your CRM configuration. If your custom field does not appear in the API response or you receive a pattern-matching error, verify the API name by inspecting the field properties directly in the module settings [2].


When updating fields across related modules, ensure you have the correct record ID and that the relationship between modules is properly defined. Attempting to update a field on a record type that does not have access to that field will cause the operation to fail silently or throw an error [5].


What to check


  • Confirm the custom field API name matches exactly what you entered in your Deluge script.
  • Verify that the record ID being targeted exists and belongs to the correct module.
  • Test the function on a non-critical record first to ensure the update produces the expected result before running it on production data.

---


Note: This article is provided by Beam Help, independent expert support for Zoho—not official Zoho support. For official documentation, consult Zoho's help portal directly.

Originally asked in the Zoho community. See the original question →

Sources cited

  1. [1] Zoho Community | Connect, network, and share on Zoho Forums
  2. [2] How to Update custom Fillable Fields via Zoho Contracts API
  3. [3] Introduction to Zoho Bookings | Help - Zoho Bookings
  4. [4] Organizational Tree Map Extension
  5. [5] Zoho Developer Community Monthly Digest – May 2025
  6. [6] Writer | Custom Function | Knowledge Base
  7. [7] Zoho Community | Connect, network, and share on Zoho Forums
Update custom fields with Deluge in Zoho CRM | Beam Help