Get Organization Variable
Table of Contents
You can set the value of a custom variable (Custom Properties in Extension and Org Settings in Vertical Solution) using the zoho.crm.getOrgVariable() deluge task.
Note:
- This task can be performed only in Zoho CRM Vertical Solutions.
- Each time the zoho.crm.getOrgVariable integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
- Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.crm.getOrgVariable integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.
Syntax
<Response> = zoho.crm.getOrgVariable("<customVariableName>");
where:
| Params | Data type | Description |
|---|---|---|
| <Response> | KEY-VALUE | Returns the value of a custom variable. |
| <customVariableName> | TEXT | The API name of the custom variable. You can find this information in the following places: In a Vertical solution: Click Company Settings in the left pane and click Org Settings. In an Extension: Click Custom Properties in the left pane. |
Example
Suppose a custom variable by the name Score is created and the current value of the variable is 23. You can fetch the value of the custom variable using the below script:
value = zoho.crm.getOrgVariable("Score"); info "The value of the custom variable, Score, is " + value;
Response Format
Success Response
{ The value of the custom variable, Score, is 23 }