Create Records in Zoho Sheet
Table of Contents
Description
The zoho.sheet.createRecords task is used to insert data into the specified worksheet of a Zoho Sheet file. This task is based on the Zoho Sheet API - Add records to Worksheet.
Syntax
<response> = zoho.sheet.createRecords(<resource_id>, <worksheet_name>, <row_data>, <query_map>, <connection>);
Params | Data type | Description |
<response> | KEY-VALUE | The details of the rows that will be created, and the status of the executed task. |
<resource_id> | TEXT | The ID of the Zoho Sheet file in which the new values need to be inserted. Note: The resource_id can be obtained from the URL of the Zoho sheet file. The URL is in the following format: https://sheet.zoho.com/sheet/open/<resource_id>/sheets/<worksheet_name> |
<worksheet_name> | TEXT | The name of the worksheet in which the data needs to be inserted. |
<row_data> | KEY-VALUE | The values of the rows that need to be inserted. |
<query_map> | KEY-VALUE | The query parameters, as given in the Zoho Sheet API. To ignore querying using this param, specify an empty map. |
<connection> | TEXT | The link name of the connection. Note:
|
Example 1: Insert row into a table
The following script inserts a row with the specified values into the worksheet - Sheet1 of the Zoho Sheet file with ID - eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41.
// Create a KEY-VALUE variable - rowData that holds values of the new row rowData = Map(); rowData.put("Email","shawn@zylker.com"); rowData.put("Name","Shawn"); rowData.put("Lead Source","Trade Show"); // Create an empty KEY-VALUE variable to skip the <query_map> param queryData = Map(); // Perform create records task to insert the new row into the worksheetsheet - Sheet1 response = zoho.sheet.createRecords("eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41","Sheet1", rowData, queryData, "sheet_connection");
where:
response
"eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41"
"Sheet1"
rowData
"Email" "Name" "Lead Source"
queryData
"sheet_connection"
Example 2: Insert multiple rows into a table
The following script inserts two rows with the specified values into the worksheet - Sheet1 of the Zoho Sheet file with ID - eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41.
// Create a KEY-VALUE variable - row1 that holds values of the first row row1 = Map(); row1.put("Email","shawn@zylker.com"); row1.put("Name","Shawn"); row1.put("Lead Source","Trade Show"); // Create a KEY-VALUE variable - row2 that holds values of the second row row2 = Map(); row2.put("Name","Brent"); row2.put("Email","brent.r@gmail.com"); row2.put("Lead Source","Advertisement"); // Create a LIST variable - rowsData that holds the variables - row1 and row2 rowsData = List(); rowsData.add(row1); rowsData.add(row2); // Create a KEY-VALUE variable to hold the query parameters queryData = Map(); // Perform create records task to insert values of row1 and row2 into the worksheetsheet - Sheet1 response = zoho.sheet.createRecords("eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41","Sheet1", rowsData, queryData, "sheet_connection");
where:
row1
row2
rowsData
Example 3: Insert row into a table whose header is not present in the first row of the worksheet
The following script inserts a new row with the specified values into the table whose header is present in the row - 3 of the worksheet - Sheet1.
// Create a KEY-VALUE variable - rowData that holds values of the new row rowData = Map(); rowData.put("Email","shawn@zylker.com"); rowData.put("Name","Shawn"); rowData.put("Lead Source","Trade Show"); // Create a KEY-VALUE variable - headerData that holds row number in which header is present headerData = Map(); headerData.put("header_row",3); // Perform create records task to insert the new row into the worksheetsheet - Sheet1 response = zoho.sheet.createRecords("eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41","Sheet1", rowData, headerData, "sheet_connection");
where:
"header_row"
Response Format
Success Response
The success response will be returned in the following format:
{
"start_column": 1,
"method": "worksheet.jsondata.append",
"start_row": 2,
"sheet_name": "Sheet1",
"end_row": 2,
"end_column": 3,
"status": "success"
}The success response will be returned in the following format when extra headers are passed:
{
"start_column": 1,
"method": "worksheet.jsondata.append",
"start_row": 3,
"warning": "Extra header found - Company",
"sheet_name": "Sheet1",
"end_row": 3,
"end_column": 3,
"status": "success"
}
Failure Response
The failure response for invalid resource ID will be returned in the following format:
{
"error_message": "The workbook does not exists",
"error_code": 2862
}The failure response for incorrect or non-existent worksheet name will be returned in the following format:
{
"error_message": "The sheet does not exists",
"method": "worksheet.jsondata.append",
"error_code": 2863,
"status": "failure"
}The failure response for non-existent header values will be returned in the following format:
{
"error_message": "No such header found",
"method": "worksheet.jsondata.append",
"error_code": 2893,
"status": "failure"
}