Choose where you’d like to start

Update Record

Table of Contents

Overview

The zoho.creator.updateRecord task is used to update a record using its ID in the specified Zoho Creator application.

Note: This task is based on the Zoho Creator V2 API - Update Record By ID

Syntax

​
<variable> = zoho.creator.updateRecord(<owner_name>, <app_link_name>, <report_link_name>, <record_id>, <new_input_values>, <other_api_params>, <connection_link_name>);

where:

ParameterData TypeDescription

<variable>

KEY-VALUE

Variable that will hold the details of the updated record.

<owner_name>

TEXT

Name of the owner of the app from which the record needs to be fetched.

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 a record needs to be updated.

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

<report_link_name>

TEXT

Link name of the report in which the record needs to be updated is available.

Note:

  • Link names of applications, 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 report. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/<application_name>/#Report:<report_link_name>

<record_id>

​

NUMBER

ID of the record that needs to be updated.

Note: You can use the zoho.creator.getRecords integration task to fetch the record ID. Click here for the Deluge script to extract record IDs from the returned response.

<new_input_values>

KEY-VALUE

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.

Note:

<other_api_params>

KEY-VALUE

Other optional parameters specified in Zoho Creator Update Record By ID API document.

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

<connection_link_name>

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 Update Record By ID API document while creating the connection.

Example

The following example updates the record with ID - 60210000000020007 from the report - All_tasks of the Zoho Creator application - Task_Management with the specified values.

 // Create a KEY-VALUE variable to hold the new record values
 dataMap = Map();
 dataMap.put("Task_Name", "Priority Task");

 // Create an empty KEY-VALUE variable to skip optional parameters
 otherParams = Map();

 // Write update record integration task
 response = zoho.creator.updateRecord("Shawn","Task_Management","All_Tasks",60210000000020007, 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.
"All_Tasks"
The TEXT value that represents the name of the report that needs to be updated.
60210000000020007
The NUMBER that represents the ID of the record that needs to be updated.
dataMap
The KEY-VALUE variable that holds the new input values.
otherParams
The KEY-VALUE variable that holds the optional parameters.

Response Format

Success Response

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

     {
     "code":3000,
     "data":{
     "ID":"60210000000020007",
     }
     }
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."
    }

  • The failure response for incorrect or non-existent record ID will be returned in the following format:

     {
     "code": 3100,
     "message": "No Data Available"
    }

Related Links

Get Started Now

Execute