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

• Automating Employee Birthday Notifications in Zoho Cliq

  Have you ever missed a birthday and felt like the office Grinch? Fear not, the Cliq Developer Platform has got your back! With Zoho Cliq's Schedulers, you can be the office party-cipant who never forgets a single cake, balloon, or awkward rendition of

• Accelerate Github code reviews with Zoho Cliq Platform's link handlers

  Code reviews are critical, and they can get buried in conversations or lost when using multiple tools. With the Cliq Platform's link handlers, let's transform shared Github pull request links into interactive, real-time code reviews on channels. Share

• App Spotlight : PagerDuty for Zoho Cliq

  App Spotlight brings you hand-picked apps to enhance the power of your Zoho apps and tools. Visit the Zoho Marketplace to explore all of our apps, integrations, and extensions. In today's fast-paced world, seizing every moment is essential for operational

• 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

• Recent Topics

• "Other Current Asset" accounts as "Paid Through" accounts in Expense

  It would be incredibly useful to be able to assign accounts of type Other Current Asset as Paid Through accounts in Expense. Currently, Other Current Liability are permitted as Paid Through Accounts. This makes sense, as Credit Cards are current liabilities.

• Multi column open text questions that allows respondents to add rows for additional information

  I need to create a question that has 2 columns with open text, but I also need to allow respondents to click a "+" button, or something similar, so that they can add additional information if they choose to. I've tried using the Multiple Textboxes type

• Bot Filtering & Apple Mail Privacy Protection Compliance in Zoho Campaigns

  Dear Campaigns Users, The wait is over! We’re excited to announce that the enhanced bot filtering feature is now live in Zoho Campaigns. This update brings greater accuracy to your email campaign reports by distinguishing real user engagement from automated

• Découvrons les détails qui simplifient vos journées de travail avec Trident

  Nous nous installons dans des routines efficaces et rodées avec le temps. Chaque matin, nous ouvrons nos e-mails, passons aux messages, consultons notre agenda, puis attaquons nos tâches. Ce processus nous semble maîtrisé, mais est-il réellement optimisé

• Issue with Purchase Rate Showing as “0” After Importing Items List

  Dear Zoho Books Support Team, Good day. I’m reaching out regarding an issue I’m facing while importing my items list into Zoho Books. Despite mapping all fields correctly and including the purchase price for each product in my Excel file, the Purchase

• API for Task Entity in Zoho Books

  I’m working on automating task creation in Zoho Books via a custom button in the Bills Module. The goal is to create a task in the Tasks Module and assign it to the Finance Team, so they can track progress efficiently. While reviewing Zoho Books documentation,

• create invoice in zoho books from the zoho forms

  Is there a native way to have create invoice in zoho books, when zoho form is completed?

• Email undelivered

  GOod Day I am always receiving an uncategorized-bounce to my email. I am not sure why this is happening.

• Add inventory_valuation_method to items endpooints

  To ensure consistent item creation it would be helpful to have the inventory_valuation_method (FIFO vs WAC) be able to be set at item creation or as an update (consistent with current behavior where it is not allowed for items with existing transactions)

• Use Zoho to send sales receipts for Gocardless transactions

  I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up

• Zoho - Gocardless sales receipts

  I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up

• Introducing Rollup summary in Zoho CRM

  ------------------------------------------Moderated on 5th July'23---------------------------------------------- Rollup summary is now available for all organizations in all the DCs. Hello All, We hope you're well! We're here with an exciting update that

• Introducing Connected Workflows in Zoho CRM for Everyone : Free Your Teams to Focus on What Matters

  Hello Everyone, We’re thrilled to introduce the next big evolution in Zoho CRM for Everyone -- Connected Workflows. This new feature builds on our commitment to deliver a CRM that’s truly inclusive, adaptable, and designed for consistent collaboration

• Introducing Connected Records to bring business context to every aspect of your work in Zoho CRM for Everyone

  Hello Everyone, We are excited to unveil phase one of a powerful enhancement to CRM for Everyone - Connected Records, available only in CRM's Nextgen UI. With CRM for Everyone, businesses can onboard all customer-facing teams onto the CRM platform to

• Cooling-off Period Just Got Better: More Coverage, More Control

  We’ve enhanced the Cooling-off Period feature in Zoho Recruit to give you more control over repeat applications and referrals. This helps you maintain a cleaner, more efficient recruitment pipeline. With this enhancement, you can: Prevent duplicate candidate

• Revenue Management: #7 Revenue Recongition in Construction & Real Estate Industry

  If you are in the construction or real estate business, you are used to long project timelines and progressive invoicing to keep up with your billing. But when does revenue get recognized? Will it happen when the contract gets signed? At different milestones

• TikTok (and other social platform) Messages and comments of the past

  When I link a social channel, Zoho will show in "Inbox", "Messages" and "Contact" sections the interaction done in the past? (comment, messages...)

• Email Integration - Zoho CRM - OAuth and IMAP

  Hello, We are attempting to integrate our Microsoft 365 email with Zoho CRM. We are using the documentation at Email Configuration for IMAP and POP3 (zoho.com) We use Microsoft 365 and per their recommendations (and requirements) for secure email we have

• How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.

  How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.

• Restrict Employee mail deletion

  Dear Zoho, Is there a way where i can restrict my employees to delete any mails from their account

• 554 5.1.8 Email Outgoing Blocked.

  Hi guys, I just singed up for mateusz.nowicki@zoho.com mail and I can't send any mails.. Why? Everytime I try to send something I got error like the one in the screenshot. Please, help me.

• Zoho IP blocked by SpamHaus

  ERROR CODE :550 - 5.7.0 Your server IP address is in the SpamHaus SBL-XBL database, bye

• File Upload in Creator's Subfrom

  Hello Sir/Madam, Here is a Problem......... Scenario: In CRM One Custom Module (Payments) have one File Upload Field now we have to Upload that File into Creator's Custom Form (Documents) have one Subform (Documents) in Document Upload Field using Deluge

• Error AS101 when adding new email alias

  Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.

• Trigger workflow base on email clic

  Searching the help and forum, I see that there were workflow trigger rules based on email. But now, I can't find this type of trigger when I create a custom workflow. What I'm looking for would be to automate the sending of an email for a new prospect,

• Bigin Form Acknowledgement

  How to troubleshoot and find out why form acknowledgement is not sending emails after form submission?

• Option to Customize Career Site URL Without “/jobs/Careers”

  Dear Zoho Recruit Team, I hope you are doing well. We would like to request an enhancement to the Career Site URL structure in Zoho Recruit. In the old version of the career site, our URL was simply: 👉 https://jobs.domain.com However, after moving to

• Zoho Mail POP & IMAP Server Details

  Hello all! We have been receiving a number of requests regarding the errors while configuring or using Zoho Mail account in POP/ IMAP clients. The server details vary based on your account type and the Datacenter in which your account is setup. Ensure

• Ever since the new Android App udpates notifications are not working

  notifications are not working for the app is its closed I followed the tutuorial to the notificaction fixed and everythig seems to be right but notifications are not workig

• Zoho Analytics & Zoho Desk - but not all desks

  I have several desks in our company and one of those is used by our HR department. I want to bring through the data to the shared Zoho Analytics workspace - except for the HR desk. Can this be excluded at data import stage ?

• Incoming Emails Not Showing Up in Zoho Inbox

  Hi - I have my Zoho email account set up to forward a copy of all incoming emails to a secondary Gmail address, whilst retaining the original email in the Zoho inbox. However, all my incoming emails are currently not showing up in my Zoho inbox, so I'm

• How to retrieve my following requests on this forum?

  Sorry, but I did not find the proper subforum for this question.

• How to list emails in a folder, e.g. Inbox, on multiple pages when using Zoho mail webpage?

  Something as shown in the figure. There are totally 50 emails in Sent folder. If "Mail per page" equals 20, then the Sent folder is split into 3 pages. When I wander through Sent folder, I can just select a specific page to jump to. BTW, it seems that

• Unable to Create Zoho Booking via the Book Appointment API

  Its giving the below error {     "response": {         "errormessage": "Error setting value for the variable:customer_details\n null",         "status": "Error"     } } Request: POST Url: https://www.zohoapis.in/bookings/v1/json/appointment attached Zoho-oauthtoken

• SHEET - Send email when a cell changes

  I would like to create a custom function for Zoho Sheet that triggers when a paticular cell changes to a specific value. This would result in sending an email to a recipient (this would be an address that remains the same and included in the script). Example: = IF(N4= "Drafted", <>EmailFunction) 1)     Cell N4 changes to "Drafted" 2)    Email is sent to recipient            or alternatively 3)    Post to chat channel I have found the Custom function editor in Sheet. I am not bad at scripting, but

• Apply transaction rules to multiple banks

  Is there any way to make transaction rules for one bank apply to other banks? It seems cumbersome to have to re-enter the same date for every account.

• 【開催報告】 福岡 ユーザー交流会 2025/8/8（金）

  皆さま、こんにちは。コミュニティチームの中野です。 8/8（金）に、福岡 ユーザー交流会を開催しました。 本投稿では、その様子をお届けします。当日の登壇資料などもこちらに共有しますので、参加できなかった皆さまもご参照ください。 今年初の開催となる福岡 ユーザー交流会では、CreativeStudio樂合同会社 前田さんによるZoho CRM / Sign / Survey の事例セッションのほか、 Zoho社員セッションでは、Zoho Forms の活用法を解説。 さらに、「見込み客・顧客データの管理/活用方法」をテーマに参加者同士でZoho

• no me llegan los correos a Zoho mail

  No puedo recibir correos pero sí enviarlos, ya hice la modificación de MX y la verificación de teléfonos, qué es lo que ocurre? gracias

• Error: Invalid login: 535 Authentication Failed

  I have used zoho with nodemailer. const transporter = nodemailer.createTransport({ host: 'smtp.zoho.com', port: 465, secure: true, auth: { user: 'example@example.com', pass: 'password' } }); While sending the mail, it shows the following error: Error:

• Zoho Renewal

  Hello, If I am not going for zoho email renewal. will i get back my free zoho account? and if yes then is it possible to get back my all free user. how many user get back 10 or 25?

• Next Page