Print

Zoho Deluge - Update Creator from CRM

What?
This is an article documenting how to update Creator from a workflow written in a Deluge Script held in ZohoCRM.

Why?
I've also started this article to document an issue we encountered where our code was as per the documentation provided, and the responses returned as successful, but the target fields did not update. This was as a result after changing the owner of the Creator app to another person and adding our previous Super Admin account as a "Developer".

How?
I'm going to demo two methods here using the <connection_link>

Setup the Connection Link
  1. Login to ZohoCRM as the creator super admin/owner (might not be the same as CRM super admin!!!)
  2. Go to Setup » Developer Space » Connections » Create Connection » Zoho
  3. Ensure you enable/tick "ZohoCreator/creatorapi".
  4. Note the name that you call it (displayed in mixed case but will be used in its lowercase form)

Method #1: Using UpdateRecords() function with Connection Link:
  1. The syntax for this is
    copyraw 
    response = zoho.creator.updateRecord( ownerName, appLinkName, formLinkName, id, dataMap, connectionlinkName);
    1.  response = zoho.creator.updateRecord( ownerName, appLinkName, formLinkName, id, dataMap, connectionlinkName); 
      Where
    • ownerName is the owner of the Creator app.
    • appLinkName is the name of the Creator app.
    • formLinkName is the name of the Creator form.
    • id is the Creator ID of the record.
    • dataMap is the map() to post.
    • connectionLinkName is the connection link obtained previously (as a string).
  2. For example:
    copyraw 
    v_RecordID = "1234567890123456789".toLong();
m_Params = Map();
m_Params.put("FieldToUpdate", "ValueToUpdateWith");
m_response = zoho.creator.updateRecord( "myAdminAccount", "myApp", "myForm", v_RecordID, m_Params, "myzohocreatorconnection");
    1.  v_RecordID = "1234567890123456789".toLong(); 
    2.  m_Params = Map(); 
    3.  m_Params.put("FieldToUpdate", "ValueToUpdateWith"); 
    4.  m_response = zoho.creator.updateRecord( "myAdminAccount", "myApp", "myForm", v_RecordID, m_Params, "myzohocreatorconnection"); 
  3. Successful Response:
    copyraw 
    {
  "criteria": "ID==1234567890123456789",
  "newvalues": [
    {
      "FieldToUpdate": "ValueToUpdateWith"
    }
  ],
  "status": "Success"
}
    1.  { 
    2.    "criteria": "ID==1234567890123456789", 
    3.    "newvalues": [ 
    4.      { 
    5.        "FieldToUpdate": "ValueToUpdateWith" 
    6.      } 
    7.    ], 
    8.    "status": "Success" 
    9.  } 

Method #2: Using API v1 (using JSON not XML)
  1. Generate AuthToken:
    1. Browser Mode: Open a browser to https://accounts.zoho.com/apiauthtoken/create?SCOPE=ZohoCreator/creatorapi
    2. OR API Mode: https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCreator/creatorapi&EMAIL_ID=<email_address>&PASSWORD=<password> where you enter your own email address and zoho password.
  2. Determine the EndPoint:
    1. Following the syntax: https://creator.zoho.com/api/<ownername>/<format>/<applicationName>/form/<formName>/record/update where ownername is the owner, format is the type (I prefer JSON), applicationName is the name of your app, and form name the Creator form name. If you are on the EU or COM domain, enter this as the TLD of your endpoint (eg. creator.zoho.eu or creator.zoho.com).
    2. For example: https://creator.zoho.eu/api/myAdminAccount/json/myApp/form/myForm/record/update
  3. The code to update a form (sample data for demonstration purposes). Note that the payload here is submitted through URL parameters:
    copyraw 
    v_AccessToken = "123abc456def789abc123def456abc";
v_Criteria = "ID=1234567890123456789";
v_EndPoint = "https://creator.zoho.eu/api/myAdminAccount/json/myApp/form/myForm/record/update/"
v_EndPoint = v_EndPoint + "?criteria=" + v_Criteria + "&FieldToUpdate=ValueToUpdateWith";
m_Params = Map();
m_Params.put("authtoken",v_AccessToken);
m_Params.put("scope","creatorapi")
response = invokeurl
[
    url :v_EndPoint
    type :POST
    parameters:m_Params.toString()
    connection:"myzohocreatorconnection"
];
    1.  v_AccessToken = "123abc456def789abc123def456abc"; 
    2.  v_Criteria = "ID=1234567890123456789"; 
    3.  v_EndPoint = "https://creator.zoho.eu/api/myAdminAccount/json/myApp/form/myForm/record/update/" 
    4.  v_EndPoint = v_EndPoint + "?criteria=" + v_Criteria + "&FieldToUpdate=ValueToUpdateWith"; 
    5.  m_Params = Map(); 
    6.  m_Params.put("authtoken",v_AccessToken); 
    7.  m_Params.put("scope","creatorapi") 
    8.  response = invokeUrl 
    9.  [ 
    10.      url :v_EndPoint 
    11.      type :POST 
    12.      parameters:m_Params.toString() 
    13.      connection:"myzohocreatorconnection" 
    14.  ]; 
  4. Successful Response:
    copyraw 
    {
  "formname": [
    "myForm",
    {
      "operation": [
        "update",
        {
          "criteria": "ID=1234567890123456789",
          "newvalues": [
            {
              "FieldToUpdate": "ValueToUpdateWith"
            }
          ],
          "status": "Success"
        }
      ]
    }
  ]
}
    1.  { 
    2.    "formname": [ 
    3.      "myForm", 
    4.      { 
    5.        "operation": [ 
    6.          "update", 
    7.          { 
    8.            "criteria": "ID=1234567890123456789", 
    9.            "newvalues": [ 
    10.              { 
    11.                "FieldToUpdate": "ValueToUpdateWith" 
    12.              } 
    13.            ], 
    14.            "status": "Success" 
    15.          } 
    16.        ] 
    17.      } 
    18.    ] 
    19.  } 

Encountered Issues:
Category: Zoho :: Article: 668