Update Variables

Purpose

To update details of variables in CRM.

Request Details

Request URL

https://www.zohoapis.com/crm/v2.1/settings/variables

To update a specific variable:
https://www.zohoapis.com/crm/v2.1/settings/variables/{variable_id (or) variable_api_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.variables.{operation_type}

Possible operation types

ALL - Full access to variable data
UPDATE - Update variable data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2.1/settings/variables/40000000047010"
(or)
curl "https://www.zohoapis.com/crm/v2.1/settings/variables/Variable444"
-X PUT
-d @updatevariables.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
3.0.08.0
Copied//Get instance of VariablesOperations Class
VariablesOperations variablesOperations = new VariablesOperations();

//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();

//List of Variable instances
List < com.zoho.crm.api.variables.Variable > variableList = new ArrayList < com.zoho.crm.api.variables.Variable > ();

//Get instance of Variable Class
com.zoho.crm.api.variables.Variable variable1 = new com.zoho.crm.api.variables.Variable();

variable1.setId(3477061000003320163 L);

variable1.setValue("4763");

variableList.add(variable1);

variable1 = new com.zoho.crm.api.variables.Variable();

variable1.setId(3477061000005817019 L);

variable1.setDescription("This is a new description");

variableList.add(variable1);

variable1 = new com.zoho.crm.api.variables.Variable();

variable1.setId(3477061000005826003 L);

variable1.setAPIName("NewAPI");

variableList.add(variable1);

request.setVariables(variableList);

//Call updateVariables method that takes BodyWrapper class instance as parameter
APIResponse < ActionHandler > response = variablesOperations.updateVariables(request);
Copiedpackage com.zoho.crm.api.sample.restapi.variables;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class UpdateVariables 
{
	@SuppressWarnings("deprecation")
	private static void updateVariables()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/settings/variables");
			HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("id", "34770617773001");
			recordObject.put("value", 45);
			recordArray.put(recordObject);
			recordObject = new JSONObject();
			recordObject.put("id", "34770617773003");
			recordObject.put("api_name", "NewAPI");
			recordArray.put(recordObject);
			requestBody.put("variables", recordArray);
			requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	@SuppressWarnings("deprecation")
	private static void updateVariable()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/settings/variables/34770617773001");
			HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("value", 80);
			recordArray.put(recordObject);
			requestBody.put("variables", recordArray);
			requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	public static void main(String[] args) 
	{
		updateVariables();
		updateVariable();
	}
}
3.0.07.x
Copied//Get instance of VariablesOperations Class
$variablesOperations = new VariablesOperations();
//Get instance of BodyWrapper Class that will contain the request body
$request = new BodyWrapper();
//List of Variable instances
$variableList = array();
$variableClass = 'com\zoho\crm\api\variables\Variable';
//Get instance of Variable Class
$variable1 = new $variableClass();
$variable1->setId("34770617444005");
$variable1->setValue("4763");
$variable1->setAPIName("er");
array_push($variableList, $variable1);
$variable1 = new $variableClass();
$variable1->setId("34770617444010");
$variable1->setAPIName("eer");
$variable1->setDescription("This is a new description");
array_push($variableList, $variable1);
$variable1 = new $variableClass();
$variable1->setId("3477061444012");
$variable1->setAPIName("re");
array_push($variableList, $variable1);
$request->setVariables($variableList);
//Call updateVariables method that takes BodyWrapper class instance as parameter
$response = $variablesOperations->updateVariables($request);
Copied<?php

class UpdateVariables 
{
	public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $curl_options[CURLOPT_URL] = "https://www.zohoapis.com/crm/v2.1/settings/variables";
        $curl_options[CURLOPT_RETURNTRANSFER] = true; 
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "PUT";
        $requestBody = array();
        $recordArray = array();
        $recordObject = array();

        $recordObject["id"] = "35240336004001";
        $recordObject["value"] = "Hsdellso";
        $recordArray[] = $recordObject;
        $requestBody["variables"] =$recordArray;
        $curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
        $headersArray = array();

        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
        
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);

        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
       
    }
    
}
(new UpdateVariables())->execute();
3.0.08.x
Copied//Get instance of VariablesOperations Class
VariablesOperations variablesOperations = new VariablesOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//List of Variable instances
List<Com.Zoho.Crm.API.Variables.Variable> variableList = new List<Com.Zoho.Crm.API.Variables.Variable>();
//Get instance of Variable Class
Com.Zoho.Crm.API.Variables.Variable variable1 = new Com.Zoho.Crm.API.Variables.Variable();
variable1.Id = 34770617444014;
variable1.Value = "4763";
variableList.Add(variable1);
variable1 = new Com.Zoho.Crm.API.Variables.Variable();
variable1.Id = 34770617444014;
variable1.Description = "This is a new description";
variableList.Add(variable1);
variable1 = new Com.Zoho.Crm.API.Variables.Variable();
variable1.Id = 347706107445001;
variable1.APIName = "NewAPI12";
variableList.Add(variable1);
request.Variables = variableList;
//Call UpdateVariables method that takes BodyWrapper class instance as parameter
APIResponse<ActionHandler> response = variablesOperations.UpdateVariables(request);
Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json.Linq;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Variables
{
    public class UpdateVariables
    {
        public static void UpdateListofVariables()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/variables");
            request.Method = "PUT";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("id", "34770617850047");
            recordObject.Add("value", 45);
            recordArray.Add(recordObject);
            recordObject = new JObject();
            recordObject.Add("id", "3477067850049");
            recordObject.Add("api_name", "NewAPI");
            recordArray.Add(recordObject);
            requestBody.Add("variables", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
        public static void UpdateVariable()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/variables/3477067022029");
            request.Method = "PUT";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("value", 80);
            recordArray.Add(recordObject);
            requestBody.Add("variables", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}
3.0.03.x.x
Copied# Get instance of VariablesOperations Class
variables_operations = VariablesOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Variable instances
variable_list = []
# Get instance of Variable Class
variable_1 = Variable()
# Set the ID
variable_1.set_id(3409643000002275025)
# Set the value
variable_1.set_value('50')
# Add the variable instance to the array
variable_list.append(variable_1)
# Get instance of Variable Class
variable_2 = Variable()
# Set the ID
variable_2.set_id(3409643000002275035)
variable_2.set_description('This is a new description')
# Add the variable instance to the array
variable_list.append(variable_2)
# Set the list to variables in BodyWrapper instance
request.set_variables(variable_list)
# Call update_variables method that takes BodyWrapper instance as parameter
response = variables_operations.update_variables(request)
Copieddef update_variables():
    import requests
    import json

    url = 'https://www.zohoapis.com/crm/v2.1/settings/variables'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    request_body = dict()
    record_list = list()

    record_object_1 = {
        'id': '3409643000002280002',
        'api_name': 'edited-variable3',
        'value': 35
    }

    record_object_2 = {
        'id': '3409643000002280002',
        'description': 'This denotes edited variable 4 description'
    }

    record_list.append(record_object_1)
    record_list.append(record_object_2)

    request_body['variables'] = record_list

    response = requests.put(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

update_variables()


def update_variable():
    import requests
    import json

    url = 'https://www.zohoapis.com/crm/v2.1/settings/variables/3409643000002280002'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    request_body = dict()
    record_list = list()

    record_object = {
        'api_name': 'edited-variable3',
        'value': 35,
        'variable_group': {
            'name': 'new_group'
        }
    }

    record_list.append(record_object)

    request_body['variables'] = record_list

    response = requests.put(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

update_variable()
1.0.010.x
Copied//Get instance of VariablesOperations Class
let variablesOperations = new VariablesOperations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new BodyWrapper();
//Array to hold Variable instances
let variableArray = [];
//Get instance of Variable Class
let variable1 = new Variable();
variable1.setId(3477061000006852038n);
variable1.setValue("4763");
variableArray.push(variable1);
variable1 = new Variable();
variable1.setId(3409643000002275035n);
variable1.setDescription("This is a new description");
variableArray.push(variable1);
variable1 = new Variable();
variable1.setAPIName("NewAPI");
variableArray.push(variable1);
//Set the array to variables in BodyWrapper instance
request.setVariables(variableArray);
//Call updateVariables method that takes BodyWrapper class instance as parameter
let response = await variablesOperations.updateVariables(request);
Copiedasync function updateVariables() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/settings/variables'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestBody = {}
    let recordArray = []

    let recordObject1 = {
        'id': '3409643000002280002',
        'api_name': 'edited-variable3',
        'value': 35
    }

    let recordObject2 = {
        'id': '3409643000002280002',
        'description': 'This denotes edited variable 4 description'
    }

    recordArray.push(recordObject1)
    recordArray.push(recordObject2)

    requestBody['variables'] = recordArray

    let requestDetails = {
        method : "PUT",
        headers : headers,
        body : JSON.stringify(requestBody),
        encoding: "utf8",
        throwHttpErrors : false
    };
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    } 
}
updateVariables()

async function updateVariable() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/settings/variables/3409643000002280002'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestBody = {}
    let recordArray = []

    let recordObject = {
        'api_name': 'edited-variable3',
        'value': 35,
        'variable_group': {
            'name': 'new_group'
        }
    }

    recordArray.push(recordObject)

    requestBody['variables'] = recordArray

    let requestDetails = {
        method : "PUT",
        headers : headers,
        body : JSON.stringify(requestBody),
        encoding: "utf8",
        throwHttpErrors : false
    };
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    } 
}

updateVariable()
2.02.x.x
Copied# Get instance of VariablesOperations Class
vo = Variables::VariablesOperations.new
# Get instance of BodyWrapper Class that will contain the request body
bw = Variables::BodyWrapper.new
# Get instance of VariableGroup Class
group = VariableGroups::VariableGroup.new
# Set Name to variable_group
group.name = 'created'
variables = []
for i in 0..1
  # Get instance of Variable Class
  variable = Variables::Variable.new
  # Set the type to Variable
  # variable.type = 'integer'
  # # Set the value
  variable.value = 2
  # Set the id
  variable.id = variable_ids[i]
  # # Set the name to variable
  # variable.name = i.to_s
  # # Set the API name to variable
  variable.api_name = i.to_s

  # # Set the description to variable
  # variable.description = i.to_s
  # # Add the variable instance to the array
  variables.push(variable)
end
# Set the list to variables in BodyWrapper instance
bw.variables = variables
# Call update_variables method that takes BodyWrapper instance as parameter
response = vo.update_variables(bw)
Copiedclass UpdateVariables

    def execute
        url = URI("https://www.zohoapis.com/crm/v2.1/settings/variables")
        req = Net::HTTP::Put.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
        headers&.each { |key, value| req.add_field(key, value) }
       
        request_body = {};
        variables_array = [];
        variable_object = {};
        variable_group={};
        variable_object["name"] = "Varisggble33";
        variable_object["id"]="3524033000006012020"
        variable_object["description"] = "This denotes variable 4 description";
        variables_array = [variable_object];
        request_body["variables"] =variables_array; 
        request_json = request_body.to_json
        req.body = request_json.to_s
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end

UpdateVariables.new.execute
1.0.0ES6
Copied//Get instance of VariablesOperations Class
let variablesOperations = new ZCRM.Variable.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Variable.Model.BodyWrapper();
//Array to hold Variable instances
let variableArray = [];
//Get instance of Variable Class
let variable1 = new ZCRM.Variable.Model.Variable();
variable1.setId(34770616852038n);
variable1.setValue("4763");
variableArray.push(variable1);
variable1 = new ZCRM.Variable.Model.Variable();
variable1.setId(34096432275035n);
variable1.setDescription("This is a new description");
variableArray.push(variable1);
variable1 = new ZCRM.Variable.Model.Variable();
variable1.setId(34770615826003n);
variable1.setAPIName("NewAPI");
variableArray.push(variable1);
//Set the array to variables in BodyWrapper instance
request.setVariables(variableArray);
//Call updateVariables method that takes BodyWrapper class instance as parameter
let response = await variablesOperations.updateVariables(request);
Copiedvar listener = 0;
class UpdateVariables {

	async updateListofVariables()	{
		var url = "https://www.zohoapis.com/crm/v2.1/settings/variables"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new UpdateVariables().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "PUT"
        var reqBody = {"variables":[
            {
                "id":"3524035631005",
                "api_name": "NewAPI"
            },
            {
                "id":"34770617773003",
                "api_name": "NewAPI"
            }
            ]}
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new UpdateVariables().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
    }

	async updateVariable()	{
		var url = "https://www.zohoapis.com/crm/v2.1/settings/variables/3524035631005"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new UpdateVariables().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "PUT"
        var reqBody = {"variables":[
			{
				"api_name": "NewAPI"
			}
		]}
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new UpdateVariables().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}

    async getToken(token) {

        if(listener == 0) {

            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){

                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }

        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://accounts.zoho.com/oauth/v2.1/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }

            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }

    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}
Copiedvariable1 = Map();
variable1.put("id", "692969000000981112");
variable1.put("value", "9");

variable2 = Map();
variable2.put("id", "692969000000983066");
variable2.put("description", "This is a new description");

variable3 = Map();
variable3.put("id", "692969000000981114");
variable3.put("api_name", "NewAPI");

variables_list = List();
variables_list.add(variable1);
variables_list.add(variable2);
variables_list.add(variable3);

param = Map();
param.put("variables", variables_list);
	response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/settings/variables"
	type: PUT
	parameters: param.toString()
	connection:"crm_oauth_connection"
];
info response;

In the request, "@updatevariables.json" contains the sample input data.

Input JSON Keys

  • idstring, mandatory

    Specify the unique ID of the variable that you want to update. Refer to Get Variables API to get unique variable ID.

For other input keys, refer to Create Variables API. You cannot update the type or variable group of the variable.

Sample Input

Copied{
    "variables": [
       {
            "id": "40000000047003",
            "value": "This is a new value"
        },
       {
            "id": "40000000047007",
            "description": "This is a new description"
        },
       {
            "id": "40000000047009",
            "api_name": "NewAPI"
        }
    ]
}

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.settings.variables.UPDATE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to update records
    Resolution: The user does not have permission to update variables. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to update variables
    Resolution: The user does not have the permission to update variables. Contact your system administrator.

  • INVALID_DATAHTTP 400

    invalid data
    Resolution: The specified ID of the variable is incorrect. Refer to Get Variables API to get unique variable ID.

  • DUPLICATE_DATAHTTP 400

    duplicate data
    Resolution: You have specified a duplicate value for one or more unique fields. Refer to Fields Metadata API to know the unique fields.

  • MANDATORY_NOT_FOUNDHTTP 400

    required field not found
    Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.

Sample Response

Copied{
    "variables": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047003"
            },
            "message": "variable updated",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047007"
            },
            "message": "variable updated",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047009"
            },
            "message": "variable updated",
            "status": "success"
        }
    ]
}