To create a function

1. Go to Setup > Developer Space > Functions.
   
2. In the Functions page, click + Create New Function.
   
3. Choose the place where the function is meant to be added.
   
   
   
   
4. Click Next.
   
5. In the Create Function page, do the following: 
   
   • Give a Name and description(optional) for the function.
     
   • Click Edit Arguments.
     
   • Set the arguments to be used in the script, with field name or custom value in CRM module.
     
     
     
     
   • Write your required function in the Deluge Script Editor. 
     
     
     
     
     
   • Click Save & Execute Script to validate your code.
     
   • Click Save.
     
6. Click Save.
   The function will be listed in the List View of the Functions page.
   

Please note that the functions specified to be used at a particular location cannot be used elsewhere. For example: a function configured for Workflow Rules cannot be used in Schedules.

Calling Functions using REST APIs

A function lets you have additional functionalities and features in your CRM apart from the conventional features. Functions needs a trigger to call it. The trigger could be in the form of a workflow, blueprint, related list or through the click of a button.

If the function needs to be triggered without employing these methods or from external sources, you can create standalone functions and make them available as API calls. Triggering functions through REST APIs which gives the flexibility to trigger it from anywhere inside Zoho CRM or from any third party application.

Sample function as an API call

A form which automatically generates a lead in your CRM with the information given as input in the form.

Step 1

Create a standalone function with the following code.

 

Note

The arguments to be passed for the above function are "FirstName", "LastName", "Company" and "Mobile". Datatype for the arguments is STRING.

Step 2

To make function available as an API

1. Go to Setup > Developer Space > Functions.
   
2. Click the Settings icon for the corresponding function which needs to be made an API.
   
3. Click REST API.
   
   
   
   
4. Set the API name for the custom function.
   
5. Enable OAuth2.0 and the API key sliders.
   
6. Click Save.
   
   
   

Note

• Select OAuth2.0 for sharing the function as an API within your organization.
  
• Select API Key for the sharing the function with any 3rd party and enable it to be used by anyone.
  

Step 3

The sample here is shown as a form created using Zoho Creator. Create the form such that it has the fields "FirstName", "LastName", "Company" and "Mobile". You can program the function to get executed upon the click of Submit button.

 

The Result

Once the Submit button is clicked, the function gets executed and the Lead is created in your CRM. The lead has the details which was given within the form.

 

Functions in Postman

Functions which are given as API calls can be tested using POSTMAN application. However, there are a few things that you need to keep in mind when executing a function in that app.

• The current supported methods for using a function as an API are GET and POST.
  
• In a POST request, under the "Body" section, select "form-data".
  
• Create a Key named "arguments" and the Value as the Input JSON object.
  
• The arguments can also be given in the URL as arguments={encoded_arguments}
  
• POST request - Arguments Limit 
  
  • In request URL - 5000 lines
    
  • In body - 95000 lines (as JSON object)
    

 

Sample arguments in "Body"

Deploying Functions in Workflow Rules

To associate function to a workflow rule

1. Go to Setup > Automation > Workflow Automation > Rules.
   
2. In the Workflow Rules page, click the Create Rule.
   
3. In the Create New Rule tab, specify workflow rule parameters.
   
4. Under Instant Actions, select Function.
   
   
   
   
5. In the Configure Function page, select a function from the Gallery, Functions (Created by users in your organization) or Write your Own using Deluge script.
   
6. Click Functions (Created by users in your organization).
   
   
   
   
7. Select the function to be triggered and click Configure.
   
   
   
   
8. In the Configure Custom Function page, complete the following steps: 
   
   • Select the module to be associated.
     
   • Under Argument Mapping section, map the argument with field name in CRM module.
     
     
     
     
   • Click Save and Associate.
     Now you can associate the gallery custom function with workflow rule.
9. Click Save in the Workflow rule page.
   Now, your customized function is associated with workflow rule. When the workflow rule is triggered, custom function will be automatically executed.