Choose where you’d like to start

Create Record in Zoho Creator

Table of Contents

Overview

The zoho.creator.createRecord task adds one or more records to the specified  Zoho Creator form with the given input field values.

Note: This integration task is based on the Zoho Creator - Add Records API.

Syntax

<variable> = zoho.creator.createRecord(<owner_name>, <app_link_name>, <form_link_name>, <input_values>, <other_params>, <connection>);

where:

ParameterData TypeDescription

<variable>

KEY-VALUE

Variable that will hold the details of the records created.

<owner_name>

TEXT

Name of the owner of the app in which the records will be created.

Note:

Name of the application owner can be fetched in the following ways:

  • From the URL of the application while editing or accessing it. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/...
  • By using the system variable - zoho.adminuser

<app_link_name>

TEXT

Link name of the application in which the records will be created.

Note:

Link name of the application can be fetched in the following ways:

  • From the URL of the application while editing or accessing it. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/<application_name>/...
  • By using the system variable -  zoho.appname
  • Link names of applications, reports, and fields in your account can also be viewed on the reference page (listed in brackets).

<form_link_name>

TEXT

Link name of the report in which the records will be created.

Note:

  • Link names of applications, forms, reports, and fields in your account can be viewed on the reference page (listed in brackets).
  • You can also fetch link names from the URL while accessing the form. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/<application_name>/#Form:<form_link_name>

<input_values>

KEY-VALUE/ LIST

To create a single record, supply input field values as a KEY-VALUE collection. The keys to this parameter are the field link names and the values are their corresponding input values.

To create more than one record, supply the input data as a LIST of KEY-VALUE collections. Data stored in each KEY-VALUE element of the LIST will be created as a record. The keys of these elements must be the field link names and values must be their corresponding input values.

Note:

  • You can add up to 200 records at once using this task.
  • Refer to the Zoho Creator Add Records API document for the rules and validations that your input data need to satisfy.
  • Link names of fields in your account can be viewed on the reference page (listed in brackets).

<other_params>

KEY-VALUE

Other optional parameters specified in Zoho Creator Add Records API document.

Note: To skip this parameter, provide an empty map as its value.

<connection>

TEXT

Link name of the connection created and connected to your Zoho Creator account. 

Note:

  • The connection should be OAuth 2 based. To create OAuth 2 based connection with Zoho services, choose the default service - Zoho OAuth under pick your service in connections page.
  • Make sure to add the scopes mentioned in the Zoho Creator Add Records API document while creating the connection.

Example 1: Create a single record

The following example creates a record in the form - Tasks of the Zoho Creator application - Task_Management:

 // Create a KEY-VALUE variable to hold the input record values
 dataMap = Map();
 dataMap.put("Task_Name", "Priority Task");
 dataMap.put("Task_Description", "I need help configuring my new toaster");

 // Create an empty KEY-VALUE variable to skip the other_params parameter
 otherParams = Map();

 //Write create records integration task to add the input data into the specified form
 response = zoho.creator.createRecord("Shawn", "Task_Management", "Tasks", dataMap, otherParams, "creator_oauth_connection");
 

where:

response
The KEY-VALUE variable that holds the response of the task
"Shawn"
The TEXT value that represents the name of the application owner.
"Task_Management"
The TEXT value that represents the link name of the application.
"Tasks"
The TEXT value that represents the link name of the form to which the record will be added.
dataMap
The KEY-VALUE variable that holds the input values of the record to be created.
"Task_Name"
"Task_Description"
The TEXT values that represent the filed link names.
"creator_oauth_connection"
The TEXT values that represent the filed link names.

Example 2: Create multiple records

The following example creates two records in the form - Tasks of the Zoho Creator application - Task_Management:

 // Create a KEY-VALUE variable to hold the input values of first record
 record1 = Map();
 record1.put("Task_Name", "Priority Task");
 record1.put("Task_Description", "I need help configuring my new toaster");
 
 // Create a KEY-VALUE variable to hold the input values of second record
 record2 = Map();
 record2.put("Task_Name", "Support Ticket 1");
 record2.put("Task_Description", "Toaster Configurations");
 
 // Create a LIST variable to hold the details of the records that need to be created
 records_list = List();
 records_list.add(record1);
 records_list.add(record2);

 // Create an empty KEY-VALUE variable to skip the other_params parameter
 otherParams = Map();

 //Write create records integration task to add the input data into the specified form
 response = zoho.creator.createRecord("Shawn", "Task_Management", "Tasks", records_list, otherParams, "creator_oauth_connection");

where:

records_list
The LIST variable that holds the details of the records to be created.
"Task_Name"
"Task_Description"
The TEXT values that represent the filed link names.

Response Format

Success Response

  • The success response will be returned in the following format:

     {
     "code": 3000,
     "data": {
     "ID": "3893272000000191003"
     },
     "message": "Data Added Successfully"
     }
Failure Response

  • The failure response for incorrect or non-existent application name will be returned in the following format

     {
     "code": 2892,
     "message": "No application named <application_name> found. Please check and try again."
    }

  • The failure response for incorrect owner name will be returned in the following format

     {
     "code": 1110,
     "message": "No workspace named <owner_name> found. Please enter a valid workspace value."
    }

  • The failure response for incorrect or non-existent report name will be returned in the following format

     {
     "code": 2894,
     "message": "No report named <report_link_name> found. Please check and try again."
    }

Related Links

Get Started Now

Execute