Zoho CRM REST API: Stop Workflow from Triggering

: Category: Zoho CRM; 16 June 2021; 16 June 2021; Hits: 22387; Rating:

( 110 Ratings )

What?
This is an article to show you how to use triggers but also how to stop them. We only found this an issue when using REST API v2.1 but also to show you how to configure triggers when using createRecord or updateRecord.

Why?
We had a Creator app updating a CRM record which in turn had a workflow to update the Stage in Creator (so a user can change the stage in CRM and it would reflect this in the equivalent Creator record). There was also a workflow that ran when the Creator record was updated to update its changes to CRM. It was actually causing a loop which used up all the API calls.

How?
You might already be familiar with some of the trigger options below but one that worked was initially guessed as "none" but then later found in the documentation could also be an empty list [].

So there are a few trigger options but I'm listing the one(s) to stop workflows below to see if this helps anyone:

Stop Workflows from executing:

copy raw

l_Quotes = List();
l_Quotes.add(m_CreateCrmQuote);
m_Data = Map();
m_Data.put("data",l_Quotes);
l_Triggers = List();
l_Triggers.add("none");
m_Data.put("trigger",l_Triggers);
v_Url = "https://www.zohoapis.eu/crm/v2.1/Quotes/" + input.CRM_Quote_ID;
r_CreateCrmQuote = invokeurl
[
    url :v_Url
    type :PUT
    parameters:m_Data.toString()
    connection:"ascentbusiness"
];

l_Quotes = List();
l_Quotes.add(m_CreateCrmQuote);
m_Data = Map();
m_Data.put("data",l_Quotes);
l_Triggers = List();
l_Triggers.add("none");
m_Data.put("trigger",l_Triggers);
v_Url = "https://www.zohoapis.eu/crm/v2.1/Quotes/" + input.CRM_Quote_ID;
r_CreateCrmQuote = invokeurl
[
url :v_Url
type :PUT
parameters:m_Data.toString()
connection:"ascentbusiness"
];

copy raw

l_Quotes = List();
l_Quotes.add(m_CreateCrmQuote);
m_Data = Map();
m_Data.put("data",l_Quotes);
m_Data.put("trigger",[]);
v_Url = "https://www.zohoapis.eu/crm/v2.1/Quotes/" + input.CRM_Quote_ID;
r_CreateCrmQuote = invokeurl
[
    url :v_Url
    type :PUT
    parameters:m_Data.toString()
    connection:"ascentbusiness"
];

l_Quotes = List();
l_Quotes.add(m_CreateCrmQuote);
m_Data = Map();
m_Data.put("data",l_Quotes);
m_Data.put("trigger",[]);
v_Url = "https://www.zohoapis.eu/crm/v2.1/Quotes/" + input.CRM_Quote_ID;
r_CreateCrmQuote = invokeurl
[
url :v_Url
type :PUT
parameters:m_Data.toString()
connection:"ascentbusiness"
];

or (untested)

copy raw

m_Trigger = Map();
m_Trigger.put("trigger",[]);
r_Update = zoho.crm.updateRecord("Module",p_RecordID,m_UpdateRecord,m_Trigger);

m_Trigger = Map();
m_Trigger.put("trigger",[]);
r_Update = zoho.crm.updateRecord("Module",p_RecordID,m_UpdateRecord,m_Trigger);

From the documentation:

The trigger input can be workflow, approval, or blueprint. If trigger is not mentioned, the workflows, approvals, and blueprints related to the API will get executed. Enter the trigger value as [] to not execute the workflows.

Source(s):