Bulk user onboarding for Cliq channels in a jiffy

As developers, we frequently switch between coding, debugging, and optimizing tasks. The last thing we want is to be burdened by manual user management. Adding users one by one to a channel is tedious and prone to errors, taking up more time than we could devote to actual development. 

Let's explore how to create a custom workflow using Cliq's platform components to streamline the process of bulk-adding users to a channel via a Zoho Sheet or CSV file. This approach facilitates a smooth onboarding experience without the need for manual effort.

---

Pre-requisite :

Before beginning to script the code below, we must create a connection with Zoho Cliq. Once a connection is created and connected, you can use it in Deluge integration tasks and invoke URL scripts to access data from the required service.

Create a Zoho Oauth default connection with any unique name and the scopes -  ZohoCliq.Channels.All and ZohoSheet.dataApi.ALL

Refer to the below links to learn more :

• Connections in Cliq
  
• Zoho Cliq REST API Documentation
  

---

Step 1  : Creation of slash command

• After a successful login in Cliq, hover to the top right corner and click your profile. Post clicking, navigate to Bots & Tools > Commands.
  
• At your right, click the button - Create Command.
  
• To know more about slash commands and their purposes, refer to Introduction to slash commands.
  
• Create a slash command using your preferred name. Specify the following details: the command name, a hint (to give users an idea of what the command is for), and the access level.
  
• Finally, click "Save & edit code".
  

1. inputs = List();
2. inputs.add({"name":"channels","label":"Pick a channel","placeholder":"Choose a channel where you need to add members","max_selections":"1","multiple":false,"mandatory":true,"type":"native_select","data_source":"channels"});
3. inputs.add({"name":"headername","label":"Header name","placeholder":"Email ID","hint":"In which the Email ID is present","min_length":"0","max_length":"25","mandatory":true,"type":"text"});
4. inputs.add({"type":"radio","label":"Import type","name":"import_Type","hint":"Choose a type that you need to import users","options":[{"label":"CSV","value":"csv"},{"label":"Zoho sheet","value":"zohosheet"}],"trigger_on_change":"true"});
5. return {"name":"addbulkuser","type":"form","title":"Add bulk users","hint":"To add maximum of upto 1000 users in a channel.","button_label":"Add Users","inputs":inputs,"action":{"type":"invoke.function","name":"addbulkusers"};

Step 2  : Scripting form function

• We need to create a function for the form that manages submission responses, including the Zoho Sheet link or CSV file, the name of the column containing the email addresses, and the channel details where users should be added in bulk.
  
• Hover to the top right corner and click your profile. After clicking, navigate to Bots & Tools > Functions.
  
• To your right, click the Create Function button.
  
• Name the function "addbulkusers," provide a description as desired, and select "form" as the function type. Then, click "Save and edit code," and paste the following code.
  

1. emailIdList = list();
2. successlist = list();
3. failedlist = list();
4. try 
5. {
6. info form;
7. formValues = form.get("values");
8. columnName = formValues.get("headername");
9. headerName = formValues.get("headername");
10. if(formValues.get("import_Type").get("value") == "zohosheet")
11. {
12. url = formValues.get("url");
13. spreadSheetId = url.getPrefix("?").getSuffix("open/");
14. sheetName = url.getSuffix("?").getPrefix("&").getSuffix("=");
15. worksheetname = sheetName.replaceAll(" ","%20");
16. columnName = columnName.replaceAll(" ","%20");
17. allDatas = list();
18. params = Map();
19. params.put("column_names",columnName);
20. params.put("method","worksheet.records.fetch");
21. params.put("worksheet_id",sheetName + "#");
22. sheetDetails = invokeurl
23. [
24. url :"https://sheet.zoho"+environment.get("tld")+"/api/v2/" + spreadSheetId
25. type :GET
26. parameters:params
27. connection:"addbulkusers"
28. ];
29. info sheetDetails;
30. if(sheetDetails.get("status") == "success" && sheetDetails.get("records").size() <= 1000)
31. {
32. allDatas.addAll(sheetDetails.get("records"));
33. }
34. else if(sheetDetails.get("status") == "success" && sheetDetails.get("records").size() > 1000)
35. {
36. return {"type":"form_error","text":"I can only able to add 1000 user. Kindly try passing with 1000 records in the sheet!!!"};
37. }
38. else
39. {
40. return {"type":"form_error","text":"I can't find any email ids. Kindly re-check the column name and header row!!!"};
41. }
42. info "allData: " + allDatas.size();
43. if(allDatas.size() > 1000)
44. {
45. return {"type":"form_error","text":"I can only able to add 1000 user. Kindly try passing with 1000 records in the sheet!!!"};
46. }
47. for each  data in allDatas
48. {
49. if(data.get(formValues.get("headername")) == null)
50. {
51. return {"type":"form_error","text":"I can't find any email ids. Kindly re-check the column name and header row!!!"};
52. }
53. emailIdList.add(data.get(formValues.get("headername")));
54. if(emailIdList.size() == 100)
55. {
56. channelID = formValues.get("channels").get("id");
57. params = {"email_ids":emailIdList};
58. info "Params: " + params;
59. addUsers = invokeurl
60. [
61. url :environment.get("base_url") + "/api/v2/channels/" + channelID + "/members"
62. type :POST
63. parameters:params.toString()
64. detailed:true
65. connection:"addbulkusers"
66. ];
67. info "Adduser: " + addUsers;
68. if(addUsers.get("responseCode") == "204")
69. {
70. successlist.addAll(emailIdList);
71. }
72. else
73. {
74. failedlist.addAll(emailIdList);
75. }
76. info "100: " + emailIdList.size();
77. emailIdList = list();
78. }
79. }
80. if(emailIdList.size() > 0)
81. {
82. channelID = formValues.get("channels").get("id");
83. params = {"email_ids":emailIdList};
84. info "Params: " + params;
85. addUsers = invokeurl
86. [
87. url :environment.get("base_url") + "/api/v2/channels/" + channelID + "/members"
88. type :POST
89. parameters:params.toString()
90. detailed:true
91. connection:"addbulkusers"
92. ];
93. info "Adduser: " + addUsers;
94. if(addUsers.get("responseCode") == "204")
95. {
96. successlist.addAll(emailIdList);
97. }
98. else
99. {
100. failedlist.addAll(emailIdList);
101. }
102. info "Email id: " + emailIdList;
103. }
104. info "Successlist: " + successlist;
105. info "Failedlist: " + failedlist;
106. if(successlist.size() > 0 && failedlist.size() > 0)
107. {
108. postMessage = {"text":"Successfully added " + successlist.size() + " member(s) and failed for " + failedlist.size() + " Member(s)"};
109. }
110. else if(successlist.size() > 0 && !failedlist.size() > 0)
111. {
112. postMessage = {"text":"Successfully added " + successlist.size() + " member(s)"};
113. }
114. else if(!successlist.size() > 0 && failedlist.size() > 0)
115. {
116. postMessage = {"text":"Adding members in channel failed for " + failedlist.size() + " member(s)"};
117. }
118. info zoho.cliq.postToChat(chat.get("id"),postMessage);
119. }
120. else
121. {
122. csvFile = formValues.get("csvFile");
123. csvFile = csvFile.getfilecontent();
124. allDatas = csvFile.toList("\n");
125. i = 0;
126. indexValue = 0;
127. indexBoolean = false;
128. for each  data in allDatas
129. {
130. if(i == 0)
131. {
132. headers = data.toList(",");
133. for each  header in headers
134. {
135. info header;
136. if(headerName == header)
137. {
138. indexBoolean = true;
139. indexValue = headers.indexOf(headerName);
140. }
141. }
142. if(indexBoolean == false)
143. {
144. return {"type":"form_error","text":"I can't find any email ids. Kindly re-check the column name and header row!!!"};
145. }
146. }
147. else 
148.             {
149. emailIdList.add(data.get(indexValue));
150.             }
151. i = i + 1;
152. if(emailIdList.size() == 100)
153. {
154. channelID = formValues.get("channels").get("id");
155. params = {"email_ids":emailIdList};
156. info "Params: " + params;
157. addUsers = invokeurl
158. [
159. url :environment.get("base_url") + "/api/v2/channels/" + channelID + "/members"
160. type :POST
161. parameters:params.toString()
162. detailed:true
163. connection:"addbulkusers"
164. ];
165. info "Adduser: " + addUsers;
166. if(addUsers.get("responseCode") == "204")
167. {
168. successlist.addAll(emailIdList);
169. }
170. else
171. {
172. failedlist.addAll(emailIdList);
173. }
174. info "100: " + emailIdList.size();
175. emailIdList = list();
176. }
177. }
178. if(emailIdList.size() > 0)
179. {
180. channelID = formValues.get("channels").get("id");
181. params = {"email_ids":emailIdList};
182. info "Params: " + params;
183. addUsers = invokeurl
184. [
185. url :environment.get("base_url") + "/api/v2/channels/" + channelID + "/members"
186. type :POST
187. parameters:params.toString()
188. detailed:true
189. connection:"addbulkusers"
190. ];
191. info "Adduser: " + addUsers;
192. if(addUsers.get("responseCode") == "204")
193. {
194. successlist.addAll(emailIdList);
195. }
196. else
197. {
198. failedlist.addAll(emailIdList);
199. }
200. }
201. info "Successlist: " + successlist;
202. info "Failedlist: " + failedlist;
203. if(successlist.size() > 0 && failedlist.size() > 0)
204. {
205. postMessage = {"text":"Successfully added " + successlist.size() + " member(s) and failed for " + failedlist.size() + " Member(s)"};
206. }
207. else if(successlist.size() > 0 && !failedlist.size() > 0)
208. {
209. postMessage = {"text":"Successfully added " + successlist.size() + " member(s)"};
210. }
211. else if(!successlist.size() > 0 && failedlist.size() > 0)
212. {
213. postMessage = {"text":"Adding members in channel failed for " + failedlist.size() + " member(s)"};
214. }
215. info zoho.cliq.postToChat(chat.get("id"),postMessage);
216. }
217. }
218. catch (e)
219. {
220. info e;
221. return {"type":"form_error","text":"I can't find any email ids. Kindly re-check the column name and header row!!!"};
222. }
223. return Map();

Step 3  : Configuring form change handler

• After copying and pasting the code into the form submission handler, navigate to the form change handler for the created form function.
  
• You can find this in the top left corner of the editor, where you will see an arrow next to the form submission handler. Clicking on this arrow will display the form change handler in a dropdown menu.
  
• Click it to edit the code in the form change handler, which is necessary for real-time modifications to a form's structure or behaviour based on user input in a specific field. 
  

1. targetName = target.get("name");
2. info targetName;
3. inputValues = form.get("values");
4. info inputValues;
5. actions = list();
6. if(targetName.containsIgnoreCase("import_Type"))
7. {
8. fieldValue = inputValues.get("import_Type").get("value");
9. info fieldValue;
10. if(fieldValue == "csv")
11. {
12. actions.add({"type":"add_after","name":"import_Type","input":{"label":"CSV File","name":"csvFile","placeholder":"Please upload a zCSV File","mandatory":true,"type":"file"}});
13. actions.add({"type":"remove","name":"url"});
14. }
15. else if(fieldValue == "zohosheet")
16. {
17. actions.add({"type":"add_after","name":"import_Type","input":{"name":"url","label":"Enter the sheet url","placeholder":"https://sheet.zoho.com/sheet/open/6xhgb324f142e91d845e5b4b472f7422379c9","min_length":"0","max_length":"400","mandatory":true,"type":"text","format":"url"}});
18. actions.add({"type":"remove","name":"csvFile"});
19. }
20. }
21. return {"type":"form_modification","actions":actions};
    

Business use cases:

• HR onboarding: Seamlessly add new employees to internal communication channels.
  
• Event management: Quickly invite attendees to event-specific channels.
  
• Education platforms: Enroll students in course groups in one go.
  
• Community building: Grow large communities by importing member lists effortlessly.
  

Bottom line

Bulk user addition in Cliq channels through Zoho Sheet or CSV files allows us to eliminate tedious tasks, reduce errors, and manage large-scale data effortlessly. Is onboarding consuming too much of your valuable development time? If so, it might be time to shake things up with a customized workflow!

We're here to help, so don't hesitate to reach out to support@zohocliq.com with any questions or if you need assistance in crafting even more tailored workflows.

• Topic Participants

• Harsha SS

  

• Sticky Posts

• Automate your status with Cliq Schedulers

  Imagine enjoying your favorite homemade meal during a peaceful lunch break, when suddenly there's a PING! A notification pops up and ruins your moment of zen. Even worse, you might be in a vital product development sprint, only to be derailed by a "quick

• Bulk user onboarding for Cliq Channels in a jiffy

  As developers, we frequently switch between coding, debugging, and optimizing tasks. The last thing we want is to be burdened by manual user management. Adding users one by one to a channel is tedious and prone to errors, taking up more time than we could

• Convert a message on Cliq into a task on Zoho Connect

  Message actions in Cliq are a great way to transform messages in a conversation into actionable work items. In this post, we'll see how to build a custom message action that'll let you add a message as a task to board on Zoho Connect. If you haven't created

• Unfurling Unlimited Possibilities in Zoho Cliq 🔗

  Are you tired of your app links looking plain? Imagine if the shared links came to life with custom previews, organized data, and one-click actions, making chats more interactive. With the Cliq platform's unfurl handlers, let's see how developers can

• Let's build a dashboard with Cliq Widgets!

  While juggling multiple tasks and tracking real-time data, you face a strict deadline for delivering a quarterly analysis report on a blank canvas while switching between different apps. Sounds exhausting, right? What if you could streamline everything

• Recent Topics

• Error when using fetchById in Client Script

  When using client script when creating page (onLoad), I suddenly getting error "Cannot read properties of undefined (reading 'Accounts')" when using: var account_details = ZDK.Apps.CRM.Accounts.fetchById(account_id); I'm getting this error whenever trying

• Episode II: Begin Your Automation Journey in Zoho Desk with Deluge

  To travel to another country, you need a passport. But that's not enough, you also need a visa, flight tickets, and, most importantly, a mode of transportation. Without these, your journey cannot begin. Similarly, custom functions in Zoho Desk are essential

• How can I capture the Cliq channel name from Deluge Script?

  I am working on a chat automation with a third party tool called Make.com. Using a webhook I am relaying information from the Bot I have created in Zoho Cliq to Make.com Webhook. I am using the Mention Handler of the bot in Cliq to relay information like

• Introducing Zoho CRM for Everyone: A reimagined UI, next-gen Ask Zia, timeline view, and more

  Hello Everyone, Your customers may not directly observe your processes or tools, but they can perceive the gaps, missed hand-offs, and frustration that negatively impact their experience. While it is possible to achieve a great customer experience by

• Backstage Roadmap to Most Requested Features

  Please provide insight as to ETA for the following: 1. Backstage integration with Zoho Showtime, seems like a no-brainer.       1.a. Why does OnAir look eerily like Showtime integration we must 'pay extra for'? 2. Backstage Integration with Zoho Subscriptions

• How to know number of days between Deal Stages?

  Hi Team - how do I know the number of days between Deal Stages? I have a Deal blueprint and I want to know the number of days it takes the Deal to be on Stage 3 to Stage 8? I can't seem to create a report for that. Our Deals have 11 Stages and our Purchasing department is in charge of Stage 3 to Stage 8 and I want to know the number of days it takes for them to complete their stages?

• How To Change Open Activities View in Canvas?

  Hi all, I want to have my open activities have this view, but I cannot see how to make it look this way in Canvas. Not only that, but there isn't a way to rearrange the Standard view in Canvas, either. What I want (this is in the Standard layout): What

• Queries in Custom Related Lists

  Hello everyone, We hope you’re having a great day! A while ago, we introduced Queries in Zoho CRM to help you dynamically fetch data from CRM modules or even external sources—right within your CRM interface. Many of you have already used Queries with

• CRM HAS BEEN SOOO SLOW For Days 05/15/25

  I have fantastic Wifi speed and have zero issues with other websites, apps, or programs. It takes an excruciatingly amount of time to simply load a record, open an email, compose an email, draft a new template, etc. Am I in a subset/region of subscribers

• Add a Calender view in Zoho CRM

  I would like to ask if it's possible to add a calendar view to a custom module in Zoho CRM. Is this feature planned for future development? It would be extremely helpful for us. I’d like to allow my users to view the data visually in a calendar layout,

• Mass emails - Allow preview of which emails will receive the email based on the criteria

  Feature request. Please allow us to view and confirm the exact recipients of the mass emails based on the criteria we've chosen before sending. It can be quite sensitive if you send the mass email to some wrong accounts accidently, so it would be great

• Customers not receiving emails

  So, a little backstory, we have been using Zoho Forms for the past eight years. And when we initially started, we would have email notifications be sent from inside Zoho Forms after a submission. We recently started using Zoho CRM as we wanted a better

• Sum Total of various fields in child module and add value to parent module field

  Hi! Having trouble with a custom function, im trying to calculate the total of all the rent and sqm fields of our offices in Products module and have them transfer to the parent module Location. The API names are as below: Child module Products = "Products"

• Automate your status with Cliq Schedulers

  Imagine enjoying your favorite homemade meal during a peaceful lunch break, when suddenly there's a PING! A notification pops up and ruins your moment of zen. Even worse, you might be in a vital product development sprint, only to be derailed by a "quick

• Important! ZipRecruiter Sponsored Posting Plan Changes in Zoho Recruit

  Greetings, We’re reaching out to inform you about an important upcoming change to the ZipRecruiter Sponsored job board integration within Zoho Recruit. What’s Changing? Starting June 1, 2025, Zoho Recruit will be updated with ZipRecruiter's latest pricing

• Generate Unique Customer ID for Each for All Contacts

  Generate Unique Customer ID for Each for All Contacts

• Mails to Deals

  Hi everybody. We are using ZOHO CRM connected to ZOHO Mail and we have a big trouble, which our ZOHO partner is not able to solve. Zoho CRM automatically connects received emails to last edited live Deal of the same Contact. For us this logic is very

• 　【Zoho CRM】サブフォーム内にあとから追加した数式項目を一括して計算させる方法

  皆様のお知恵を拝借いたしたくご相談させてください。 【状況】 任意のタブにすでにサブフォームが設定されており、そのサブフォームを含め、既に数千件のデータが存在している。 【実施したいこと】 新たに数式項目をそのサブフォームに追加して、入力済データのレコードも含めて、その数式項目の計算結果を反映させたい。項目の更新で数式項目をサブフォームに追加しただけでは計算されません。 【わかっていること】 任意のタブのサブフォーム外にあとから数式項目を追加した場合、数式項目を追加しただけでは当然数式項目の計算結果は反映されませんが、以下の方法を実施すると数式項目が計算されます。

• ICICI Bank integration

  Why the ICICI bank integration has been disabled? We opened the ICICI bank account only for integraton with Zoho. It is taking lot of time to do manual payments using file upload method. When will be the new ICICI bank integration enabled in India?

• Add Direct Ticket Link to Zoho Help Center Portal in Email Replies

  Hi Zoho Support Team, We hope you're doing well. We’d like to request a small but valuable improvement to enhance the usability of the Zoho Help Center portal (https://help.zoho.com/portal/en/myarea). Currently, when someone from Zoho replies to a support

• Task reminder with custom function

  Hello! I am trying to create a custom function to add a task. With you guys helping, I could create a function but I could not set the reminder. Anyone knows how to add a reminder?  Thank you for your tips!

• Google Drive

  How to add more modules in google drive as I don't want Zoho space? TIA

• View Expenses in Zoho Books Without Approval or Reports in Zoho Expense

  Hello, I’m using both Zoho Books and Zoho Expense (on the free plan for both). I would like to view the expenses recorded in Zoho Expense within Zoho Books, but I read that they need to be approved first. Since I manage a small freelance business, I don’t

• One notebook is on my Android phone app, but not on Web or PC app.

  This problem started in stages. At first my phone was occasionally failing to sync. Then I noticed two things added to my Phone App. One was an existing notebook had a new cover, and the other was a new Note Card with an odd text in it. These were only

• Ajust quantities in another form based on subform, on form submission

  Hello, I have an Order form with a LineItems subform. The LineItems subform has many lookups that import data from various other forms. I want to deduct the quantity offered in one of those other form, called Offer. In another application I used the following

• Workdrive connection in Zoho CRM not working

  Hi, in https://crm.zoho.com.au/crm/orgXXXXXX/settings/connections i have set up the connection for WorkDrive which is pretty much setting up the name and the scopes. But I get "WorkDrive API test response: {"errors":[{"id":"F7003","title":"Invalid OAuth

• Best Way to Update Subscriber Preferences for an Existing List?

  We currently have a mailing list of over 43,000 contacts in Zoho Campaigns, and we’re looking to segment our list based on subscriber content preferences—things like Free Webinars, Local Training, Store Specials, and New Product Announcements. We’d like

• Zoho CRM to Zoho Projects Workflow {"error":{"code":6831,"message":"Input Parameter Missing"}} connecting

  void automation.Untitled_Function(String ProjName) { resp = invokeurl [ url :"https://projectsapi.zoho.com/restapi/portals/" type :GET connection:"zohoprojects" ]; info "Portal API Response: " + resp; portalId = null; if(resp != null) { if (resp.containsKey("portals"))

• What's New in Zoho Inventory | January - March 2025

  Hello users, We are back with exciting new enhancements in Zoho Inventory to make managing your inventory smoother than ever! Check out the latest features for the first quarter of 2025. Watch out for this space for even more updates. Email Insights for

• Learning how to customize templates via code and best practices

  Hi! Our developers team want to learn how to edit our template files safely. The last time we messed with these files our site went down for a day and we had to reconfigure it from scratch. What are the best practices to do this? How can we get a template

• Inquiry: Integrating In-house Chatbot with Zoho Desk for Live Agent Support

  Hi Team, We are exploring the possibility of integrating our existing in-house chatbot with Zoho Desk to provide seamless escalation to live agents. Our requirement is as follows: within our chatbot interface, we want to offer users a "Talk to Agent"

• I need to know the IP address of ZOHO CRM.

  The link below is the IP address for Analytics, do you have CRM's? https://help.zoho.com/portal/ja/kb/analytics/users-guide/import-connect-to-database/cloud-database/articles/zoho-analytics%E3%81%AEip%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9 I would like to

• You are forced to store/manage custom functions redundantly | Any solutions?

  Hello there, you are forced to store code (custom functions) redundantly if you want to use the same functionality in multiple departments. I don't understand that you can't define global functions. When I make a change to a function I may have to do

• Integrating Zoho CRM with Quickbooks Enterprise?

  Does anyone have any experience of integrating Zoho CRM with Quickbooks Enterprise?  The Zoho pages refer to the Quickbooks Premier edition, and I wanted to know if the same works with the Quickbooks Enterprise version.

• in Desk - Why can't I find where to enable multi-branding?

  I'm looking at the knowledge base article & it says to go to settings / general / rebranding / multi-branding. But there's no multi-branding there!

• Edit a previous reconciliation

  I realized that during my March bank reconciliation, I chose the wrong check to reconcile (they were for the same amount on the same date, I just chose the wrong check to reconcile). So now, the incorrect check is showing as un-reconciled. Is there any way I can edit a previous reconciliation (this is 7 months ago) so I can adjust the check that was reconciled? The amounts are exactly the same and it won't change my ending balance.

• How to undo a reconciliation?

  I need to update the "Expense Account" field on a bunch of expenses that I've already reconciled.  However, the system will not allow this field the be changed since it is reconciled.  I haven't found a way to remove the reconciliation status for the

• Edit Reconciled Transactions

  I realize transaction amounts and certain accounts cannot be edited easily once reconciled, but when I audit my operational transactions quarterly and at the end of the year sometimes I need to change the expense account for a few transactions. To do

• Zoho support Can not send invitation email to portal user

  I try to use Zoho support but have a problem. I don't know why. - When a customer sign up at the portal user they don't receive the invitation email. - When I go to contact manu, choose 1 user and click invite --> they don't receive the invitation email.

• How to Send Automatic Warning Email After 3 Late Arrivals in Zoho People?

  I’m looking to set up an automation in Zoho People where a warning message is automatically sent to employees who have 3 or more late arrivals within a specific time period (like the past 30 days). Here’s what I’m trying to achieve: Monitor employee check-in

• Next Page