Update Record
Table of Contents
Note: This task is applicable to all Zoho services except Zoho Creator.
Overview
This task is used to update values of a particular record using its ID in a Zoho Cliq database.
This task is based on Zoho Cliq API - Update a record
Syntax
<variable> = zoho.cliq.updateRecord(<database_name>, <record_ID>, <values_map>, <connection>);
where,
Parameter | Data type | Description |
<response> | KEY-VALUE | specifies the variable which will hold the response returned by Zoho Cliq. |
<database_name> | TEXT | specifies the unique name of the database that is to be updated |
<record_ID> | NUMBER | specifies the ID of the record which will be updated. Learn how to fetch the record ID after creating or fetching records. |
<values_map> | KEY-VALUE | specifies the new values to update the record, with each key representing the unique column name in the database and the new value to be updated. |
<connection> | TEXT | specifies the link name of the Zoho Cliq connection. Note:
|
Example1: Updating a record with static values
The following script updates the availability to false in the record with ID - 1775XXXX0002XXXX009 of the Zoho Cliq database - availabilitydatabase.
values_map=Map(); values_map.put("availability",false); response_map=zoho.cliq.updateRecord("availabilitydatabase",1775XXXX0002XXXX009,values_map, "cliq_connection");
where,
response_map
"availabilitydatabase"
1775XXXX0002XXXX009
values_map
"cliq_connection"
Example2: Updating a record with dynamic values
Write the below script in the message handler of your Bot configuration to make it update a record of the Zoho Cliq database - availabilitydatabase. The value of the availability field is updated based on the user's response. If the user sends YES to the Bot, the availability field is set to true. Otherwise, it is set with the default value false.
response=Map(); dynamic_value=false; if(message.equalsIgnoreCase("YES")) { dynamic_value=true; } text = zoho.cliq.updateRecord("availabilitydatabase",1775XXXX0002XXXX423,{"availability":dynamic_value}, "cliq_connection"); response.put("text",text); return response;
where,
message
dynamic_value
"availabilitydatabase"
text
cliq_connection
Sample Response
Success Response
The success response returned is of the following format
{
"status":"SUCCESS",
"url":"/api/v2/storages/availabilitydatabase/records",
"object":{"empid":"1","name":"Hanna","availability":false,"id":"1775XXXX0002XXXX009"}
}
Failure Response
The failure response returned for an incorrect database name is of the following format
{
"status":"FAILURE",
"message":"Uh-oh! Looks like availabilitydata does not exist.",
"code":"platform_storage_database_not_found"
}The failure response returned for an incorrect record ID is of the following format
{
"status":"FAILURE",
"message":"No record found for this id",
"code":"platform_storage_record_not_exists"
}
Related Links
- Zoho Cliq API
- Common error codes can be viewed here