Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Create Variables

Purpose

To create a new variable in CRM.

Request Details

Request URL

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.variables.{operation_type}

Possible operation types

ALL - Full access to variable data
CREATE - Create variable data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/settings/variables"
-X POST
-d @createvariables.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.setName("Variable551");

variable1.setAPIName("Variable551");

VariableGroup variableGroup = new VariableGroup();

variableGroup.setId(3477061000003089001 L);

variable1.setVariableGroup(variableGroup);

variable1.setType("integer");

variable1.setValue("55");

variable1.setDescription("This denotes variable 5 description");

variableList.add(variable1);

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

variable1.setName("Variable661");

variable1.setAPIName("Variable661");

variableGroup = new VariableGroup();

variableGroup.setName("General");

variable1.setVariableGroup(variableGroup);

variable1.setType("text");

variable1.setValue("Hello");

variable1.setDescription("This denotes variable 6 description");

variableList.add(variable1);

request.setVariables(variableList);

//Call createVariables method that takes BodyWrapper instance as parameter
APIResponse < ActionHandler > response = variablesOperations.createVariables(request);
Copiedimport 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.HttpPost;
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 CreateVariables 
{
	@SuppressWarnings("deprecation")
	public static void main(String[] args) 
	{
		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/settings/variables");
			HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("name", "Variable33");
			recordObject.put("api_name", "Variable33");
			JSONObject variableGroup = new JSONObject();
			variableGroup.put("id", "34770613089001");
			recordObject.put("variable_group", variableGroup);
			recordObject.put("type", "integer");
			recordObject.put("value", 33);
			recordObject.put("description", "This denotes variable 3 description");
			recordArray.put(recordObject);
			recordObject = new JSONObject();
			recordObject.put("name", "Variable44");
			recordObject.put("api_name", "Variable44");
			variableGroup = new JSONObject();
			variableGroup.put("id", "34770613089001");
			recordObject.put("variable_group", variableGroup);
			recordObject.put("type", "text");
			recordObject.put("value", "Hello");
			recordObject.put("description", "This denotes variable 4 description");
			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();
		}
	}
}
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->setName("asdasd");		
$variable1->setAPIName("sdsd");		
$variableGroup = new VariableGroup();		
$variableGroup->setName("General");		
$variableGroup->setId("34770613089001");		
$variable1->setVariableGroup($variableGroup);		
$variable1->setType("integer");		
$variable1->setValue("42");		
$variable1->setDescription("This denotes variable 5 description");		
array_push($variableList, $variable1);		
$variable1 = new $variableClass();		
$variable1->setName("Variable661");		
$variable1->setAPIName("Variable661");		
$variableGroup = new VariableGroup();		
$variableGroup->setName("General");		
$variable1->setVariableGroup($variableGroup);		
$variable1->setType("text");		
$variable1->setValue("H2ello");		
$variable1->setDescription("This denotes variable 6 description");		
array_push($variableList, $variable1);		
$request->setVariables($variableList);		
//Call createVariables method that takes BodyWrapper instance as parameter
$response = $variablesOperations->createVariables($request);
Copied<?php

class CreateVariables 
{
	public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $curl_options[CURLOPT_URL] = "https://www.zohoapis.com/crm/v2/settings/variables";
        $curl_options[CURLOPT_RETURNTRANSFER] = true; 
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "POST";
        $requestBody = array();
        $recordArray = array();
        $recordObject = array();
        $recordObject["name"]="Variaggble33";
        $recordObject["api_name"]="Variaggble33"; 
        $variableGroup=array();
        $variableGroup["id"]="35240335550001";
        $recordObject["variable_group"] = $variableGroup;
        $recordObject["type"] = "text";
        $recordObject["value"] = "Hesdllo";
        $recordObject["description"] = "This denotes variable 4 description";
        $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 CreateVariables())->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.Name = "Variable5521";
variable1.APIName = "Variable5521";
API.VariableGroups.VariableGroup variableGroup = new API.VariableGroups.VariableGroup();
variableGroup.Id = 34770613089001;
variable1.VariableGroup = variableGroup;
variable1.Type = "integer";
variable1.Value = "55";
variable1.Description = "This denotes variable 5 description";
variableList.Add(variable1);
variable1 = new Com.Zoho.Crm.API.Variables.Variable();
variable1.Name = "Variable6621";
variable1.APIName = "Variable6621";
variableGroup = new API.VariableGroups.VariableGroup();
variableGroup.Name = "General";
variable1.VariableGroup = variableGroup;
variable1.Type = "text";
variable1.Value = "Hello";
variable1.Description = "This denotes variable 6 description";
variableList.Add(variable1);
request.Variables = variableList;
//Call CreateVariables method that takes BodyWrapper instance as parameter
APIResponse<ActionHandler> response = variablesOperations.CreateVariables(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 CreateVariables
    {
        public static void CreateVariable()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/settings/variables");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("name", "Variable33");
            recordObject.Add("api_name", "Variable33");
            JObject variableGroup = new JObject();
            variableGroup.Add("id", "34770613089001");
            recordObject.Add("variable_group", variableGroup);
            recordObject.Add("type", "integer");
            recordObject.Add("value", 33);
            recordObject.Add("description", "This denotes variable 3 description");
            recordArray.Add(recordObject);
            recordObject = new JObject();
            recordObject.Add("name", "Variable44");
            recordObject.Add("api_name", "Variable44");
            variableGroup = new JObject();
            variableGroup.Add("id", "3477063089001");
            recordObject.Add("variable_group", variableGroup);
            recordObject.Add("type", "text");
            recordObject.Add("value", "Hello");
            recordObject.Add("description", "This denotes variable 4 description");
            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 API name to variable
variable_1.set_api_name('Variable551')
# Set the name to variable
variable_1.set_name('Variable551')
# Get instance of VariableGroup Class
variable_group = VariableGroup()
# Set ID to variable_group
variable_group.set_id(3409643000002275023)
# Set the VariableGroup to Variable instance
variable_1.set_variable_group(variable_group)
# Set the type to Variable
variable_1.set_type('integer')
# Set the value
variable_1.set_value('55')
variable_1.set_description('This denotes variable 5 description')
# Add the variable instance to the array
variable_list.append(variable_1)
# Get instance of Variable Class
variable_2 = Variable()
# Set the API name to variable
variable_2.set_api_name('Variable551')
# Set the name to variable
variable_2.set_name('Variable551')
# Get instance of VariableGroup Class
variable_group = VariableGroup()
# Set ID to variable_group
# variable_group.set_id(3409643000002275023)
variable_group.set_name("New VG")
# Set the VariableGroup to Variable instance
variable_2.set_variable_group(variable_group)
# Set the type to Variable
variable_2.set_type('text')
# Set the value
variable_2.set_value('Python')
variable_2.set_description('This denotes variable 5 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 create_variables method that takes BodyWrapper instance as parameter
response = variables_operations.create_variables(request)
Copieddef create_variables():
    import requests
    import json

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

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

    request_body = dict()
    record_list = list()

    record_object_1 = {
        'name': 'variable3',
        'api_name': 'variable3',
        'variable_group': {
            'id': '3409643000002275023'
        },
        'type': 'integer',
        'value': 33
    }

    record_object_2 = {
        'name': 'variable4',
        'api_name': 'variable4',
        'variable_group': {
            'name': 'new_group'
        },
        'type': 'text',
        'value': 'Hello',
        'description': 'This denotes variable 4 description'
    }

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

    request_body['variables'] = record_list

    response = requests.post(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())

create_variables()
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();
//Set the name to variable
variable1.setName("Variable551");
//Set the API name to variable
variable1.setAPIName("Variable551");
//Get instance of VariableGroup Class
let variableGroup = new VariableGroup();
//Set the ID to VariableGroup instance
variableGroup.setName("Create me");
//Set the VariableGroup to Variable instance
variable1.setVariableGroup(variableGroup);
//Set the type to Variable
variable1.setType("integer");
//Set the value to Variable
variable1.setValue("55");
variable1.setDescription("This denotes variable 5 description");
//Add the variable instance to the array
variableArray.push(variable1);
variable1 = new Variable();
variable1.setName("Variable661");
variable1.setAPIName("Variable661");
variableGroup = new VariableGroup();
variableGroup.setName("General");
variable1.setVariableGroup(variableGroup);
variable1.setType("text");
variable1.setValue("Hello");
variable1.setDescription("This denotes variable 6 description");
//Add the variable instance to the array
variableArray.push(variable1);
//Set the array to variables in BodyWrapper instance
request.setVariables(variableArray);
//Call createVariables method that takes BodyWrapper instance as parameter
let response = await variablesOperations.createVariables(request);
Copiedasync function createVariables() {
    const got = require("got");

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

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

    let requestBody = {}
    let recordArray = []

    let recordObject1 = {
        'name': 'variable3',
        'api_name': 'variable3',
        'variable_group': {
            'id': '3409643000002275023'
        },
        'type': 'integer',
        'value': 33
    }

    let recordObject2 = {
        'name': 'variable4',
        'api_name': 'variable4',
        'variable_group': {
            'name': 'new_group'
        },
        'type': 'text',
        'value': 'Hello',
        'description': 'This denotes variable 4 description'
    }

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

    requestBody['variables'] = recordArray

    let requestDetails = {
        method : "POST",
        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);
    } 
}
createVariables()
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
# List to hold Variable instances
variables = []
# Get instance of VariableGroup Class
group = VariableGroups::VariableGroup.new
# Set Name to variable_group
group.name = 'created'
for i in 10..14
  # Get instance of Variable Class
  variable = Variables::Variable.new
  # Set the type to Variable
  variable.type = 'integer'
  # Set the value
  variable.value = 1
  # Set the name to variable
  variable.name = i.to_s
  # Set the API name to variable
  variable.api_name = i.to_s
  # Set the VariableGroup to Variable instance
  variable.variable_group = group
  # 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 create_variables method that takes BodyWrapper instance as parameter
response = vo.create_variables(bw)
Copiedclass CreateVariables

    def execute
        url = URI("https://www.zohoapis.com/crm/v2/settings/variables")
        req = Net::HTTP::Post.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["api_name"] = "Variasgble33";
        variable_group["id"]="3524033000005550001";
        variable_object["variable_group"] = variable_group;
        variable_object["type"] = "text";
        variable_object["value"] = "Hesdllo";
        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

CreateVariables.new.execute
1.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();
//Set the name to variable
variable1.setName("Variable555");
//Set the API name to variable
variable1.setAPIName("Variable555");
//Get instance of VariableGroup Class
let variableGroup = new ZCRM.VariableGroup.Model.VariableGroup();
//Set the ID to VariableGroup instance
variableGroup.setName("Create me");
//Set the VariableGroup to Variable instance
variable1.setVariableGroup(variableGroup);
//Set the type to Variable
variable1.setType("integer");
//Set the value to Variable
variable1.setValue("55");
variable1.setDescription("This denotes variable 5 description");
//Add the variable instance to the array
variableArray.push(variable1);
variable1 = new ZCRM.Variable.Model.Variable();
variable1.setName("Variable666");
variable1.setAPIName("Variable666");
variableGroup = new ZCRM.VariableGroup.Model.VariableGroup();
variableGroup.setName("General");
variable1.setVariableGroup(variableGroup);
variable1.setType("text");
variable1.setValue("Hello");
variable1.setDescription("This denotes variable 6 description");
//Add the variable instance to the array
variableArray.push(variable1);
//Set the array to variables in BodyWrapper instance
request.setVariables(variableArray);
//Call createVariables method that takes BodyWrapper instance as parameter
let response = await variablesOperations.createVariables(request);
Copiedvar listener = 0;
class CreateVariables {

	async createVariable()	{
		var url = "https://www.zohoapis.com/crm/v2/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 CreateVariables().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "POST"
        var reqBody = {"variables":[
			{
				"name": "Variable33",
				"api_name":"Variable33",
				"variable_group":{
					"id": "35240335550001"
				},
				"type": "integer",
				"value": 33,
				"description":"This denotes variable 3 description"
			},
			{
				"name": "Variableasd33",
				"api_name":"Varisadable33",
				"variable_group":{
					"id": "35240335550001"
				},
				"type": "integer",
				"value": 33,
				"description":"This denotes variable 3 description"
			}
		]}
        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 CreateVariables().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/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("name", "Variable99");
variable1.put("api_name", "Variable99");
variable1.put("variable_group", {"id":"692969000000981099"});
variable1.put("type", "integer");
variable1.put("value", "99");
variable1.put("description", "This denotes variable 9 description");

variable2 = Map();
variable2.put("name", "Variable22");
variable2.put("api_name", "Variable22");
variable2.put("variable_group", {"name":"Group2"});
variable2.put("type", "text");
variable2.put("value", "Hello");
variable2.put("description", "This denotes variable 2 description");

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

Show full

Show less

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

Input JSON Keys

To create variables, send a POST request with request body containing the following attributes:

  • namestring, mandatory

    Specify the display name of the variable that you want to create. It is a unique field.
    Example: VariableName3

  • api_namestring, mandatory

    Specify the name with which the variable is to be referred in any API request. It is a unique field.
    Example: MainVariable

  • typestring, optional

    Specify the data type of the variable.
    Possible values: integer, text, percent, double, currency, date, datetime, email, phone, website, checkbox, textarea, long

  • variable_groupJSON object, mandatory

    Specify the group to which the variable must belong to.
    Example: {"id": 40000000047005} or {"name":"Group2"}

  • valuedepends on type, optional

    Specify the default value of the variable.
    Example: 123

  • descriptionstring, optional

    Specify a short description of the variable.
    Example: A short description of the variable.

Sample Input

Copied{
    "variables": [
       {
            "name": "Variable33",
            "api_name": "Variable33",
            "variable_group": {
                "id": "40000000047005"
            },
            "type": "integer",
            "value": 33,
            "description": "This denotes variable 3 description"
        },
       {
            "name": "Variable44",
            "api_name": "Variable44",
            "variable_group": {
                "name": "Group2"
            },
            "type": "text",
            "value": "Hello",
            "description": "This denotes variable 4 description"
        }
    ]
}

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.CREATE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to create records
    Resolution: The user does not have permission to create 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 add variables
    Resolution: The user does not have the permission to add variables. Contact your system administrator.

  • PATTERN_NOT_MATCHEDHTTP 400

    Please check whether the input values are correct
    Resolution: The value specified for "type" key is incorrect. Refer to Input JSON Keys and specify a valid input.

  • INVALID_DATAHTTP 400

    invalid data
    Resolution: The input specified is incorrect. Refer to Input JSON Keys section above and specify the valid input.

  • 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.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: You have not specified one or more mandatory fields in the input. Refer to Input JSON Keys section above and specify all the mandatory fields in the input.

Sample Response

Copied{
    "variables": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047009"
            },
            "message": "variable added",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047010"
            },
            "message": "variable added",
            "status": "success"
        }
    ]
}