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

• 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

• Recent Topics

• Empowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM

  Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individuals

• Announcing new features in Trident for Windows (v.1.27.6.0)

  Hello Community, Trident for Windows is here with exciting new features to elevate your email communication. Let’s dive into what’s new! View and manage .pst files. A .pst (Personal Storage Table) file is an Outlook Data Storage file format for storing

• Email limit reached

  I'm assessing whether zoho crm will work for our startup, however I tried to send emails to my leads and after 12 emails got the notification that email limit has been reached. That is ridiculously low. Whats wrong and how can you fix that. I am still

• Importing Into Zoho CRM

  Do you have a list in Excel that you would like to import into Zoho CRM? If your administrator has not restricted your ability to import, the process is fairly easy to accomplish, but understanding the options can make everything go smoother. First you may need to prepare the spreadsheet Remove any extra rows from the top of the spreadsheet, like titles or blank lines. Row 1 should be the column headers. Row 2 should be where the data starts. Make sure that there is a column for any required fields

• Agent working hours

  Hi, I know it is possible to set company business hours but is it possible so that agents can have different ones? I.e. some agents cover later hours on specific weeks - can these be set so those agents that are "working" get notified about tickets etc. 

• Analyze the Name of the Deal Owner and Created by

  I need to display the Name of the User who created a deal and the Deal Owner. Since both fields are lookups to the same table (Users), it defaults to the user record of the Deal Owner and I cannot display the name of who created it. I can generate the

• Date Import Problems

  I'm trying to import products from csv/xls files, but I can't get the Sales Start Date field to import. I know the import is working because all the other information is imported, but the Sales Start Date field is left empty. I think it must be a format

• Support Mixed Visibility Settings in Knowledge Base Categories

  Hello Zoho Desk Team, We hope you're all doing well. We’d like to submit a feature request regarding visibility settings in the Knowledge Base module. 🎯 Current Limitation As of today, when a category is set to a specific visibility level (e.g., Public),

• Canvas and Related lists

  Hi, As much as I like canvas, when adding in a asection with related lists,it doesnt mimic the same functionality as the standard view within the CRM e.g left hand panel will show the module and total number of records. Is there a way of indicating this

• Conditional Layouts On Multi Select Field

  How we can use Conditional Layouts On Multi Select Field field? Please help.

• Zoho Notifications - Received two notifications for one message and none for the other

  We had a client reply to a ticket twice in one minute. The ticket owner received two emails for the second message but none for the first (which was crucial content and unfortunately was therefore missed). I'm assuming this created a race condition -

• New Search Function

  Hey Team, The search function updated in our CRM about a week ago, so I assume it was an automated update across Zoho. It no longer displays leads/deals etc in Chronological order so that the most recently created or updated is the first to display which

• Format handling error

  Hi, I'm having an issue when merging a document using a custom function when with decimal numbers. In my template preview, it's seems correct ,but when I do the merge and attach the file to a record, all types of docs aren't displaying the number correctly.

• Better integration between Zoho CRM and Zoho Bookings

  I've noticed that when a meeting which was created in Zoho Bookings is updated by a sales person in Zoho CRM, the change is not reflected back into Zoho Bookings. I have raised this with support who advised that meetings created in Bookings need to be

• Offline mode on Android TV app?

  Hello! Is there a way to use Zoho Show offline in the Android TV app? I have an Android TV based projector, and I travel with it, and don't want to have to rely on a steady internet connection when giving a presentation.

• Enhancements to Custom Connectors in Zoho Creator

  Hello everyone, At Zoho Creator, we believe in providing you with the necessary tools to achieve a well connected ecosystem of apps. Our Custom Connectors feature is a testament to this, enabling you to integrate with a wide range of external services

• issues with manually shipping sales orders - advise needed please

  we are new to zoho inventory. we are going to roll the program out to our company within a couple of weeks and during the implementation process we have come into a roadblock with manually packaging and shipping sales orders. its important to note important

• Problem with the "Search" function

  Hi, I've been using Workdrive for a few days and lately, the files I added in Workdrive don't appear in the search. It looks like my latest files aren't indexed. Are you aware of this issue ? 

• Connect Woocommerce new order to zoho books via zoho flow

  Hello i want help to create a flow to create a new sales order from woocommerce to zoho books. Can someone send me step by step flow, functions and fields?

• [Webinar] Deluge Learning Series - AI-Powered Automation using Zoho Deluge and Gemini

  We’re excited to invite you to an exclusive 1-hour webinar where we’ll demonstrate how to bring the power of Google’s Gemini AI into your Zoho ecosystem using Deluge scripting. Whether you're looking to automate data extraction from PDFs or dynamically

• Getting error "invalid warehouse_id" when trying to update any transaction in Zoho books

  I got a message from Zoho saying that the Warehouse and Branch has been merged into one category "Locations" Once I migrated to this setup I was no longer able to edit any invoice / create creadit notes - got an error saying "invalid warehouse_id" I never

• customize payment page

  Is there a way to customize, other than the theme colour, the payment page that customers are taken to from invoices? I can't seem to find a way. I just don't like the formatting of the current page and would like to make it look better. I've looked at

• Delay function execute

  I've got a workflow which uses a webhook to send information to Flow, which in return updates a record in Creator. Problem is, by the time this has executed, the rest of my script has run and can't find the (yet to be) updated info in the record. Is there

• Zoholics Europe Awards

  We're excited to announce that at this year's Zoholics events across Europe, we're holding customer awards for the first time ever! This is your chance to shout about the amazing things you've created, connected, or achieved with Zoho's developer application!

• Return "kit_quantity" when fetching Kit items via "List all the items" API call

  I have been appreciating the new Kits feature quite a bit, it is exactly what we were looking for in Zoho to solve many pain points. However, there is 1 problem I am running into and that is the fact there is no stock information that can be pulled for

• Mapping Issue

  since, Tickets are already mapped with the Requestors and when we map Requestors with Organization, then Tickets are not visible under that Organization. Kindly solve this issue.

• Automating Pricing in Zoho Inventory Based on Brandline Quantity

  I am currently setting up my Zoho Inventory system and would like to implement an automatic pricing feature for sales orders. We have created a custom field called "brandline" for our items. All products with the same brandline value should have the same

• Tags with Zapier

  Maybe I'm missing something....I hope so... Using tags for triggers is a key need.  This prevents us from having a ton of different lists. I am trying to find out how to add a tag using zapier when someone makes a purchase....but it doesn't seem to be

• Print & PDF Support for Composite items

  There needs to be a way to print a composite item showing all the components, qty & images.

• Build custom AI solutions with Catalyst’s QuickML capabilities in CRM

  Hello everyone, We’re thrilled to announce an improvement for our Zoho CRM Enterprise users: the ability to create custom AI solutions using Catalyst’s QuickML directly from Zoho CRM. As you may already know, Zia, Zoho CRM’s AI-powered assistant, offers

• Querying CloudSQL using NodeJS?

  How can I query CloudSQL over nodejs? Are there any rest apis from which I perform Select Queries in the data of a Workspace? In the v1 we had C#, Python, Java for CloudSQL Now I only see Java? I am confused about the overall API of Analytics, there any

• We cant create a custom function

• More context, fewer tabs: View lookup modules' data within a CRM Canvas page

  Hello everyone, How often do your users juggle multiple browser tabs just to piece together the full context of a record? This update can make their lives easier. You can now add lookup modules' fields to a Canvas detail view page and a Canvas list view

• Claude + MCP Server + Zoho CRM Integration – AI-Powered Sales Automation

  Hello Zoho Community 👋 I’m excited to share a recent integration we’ve worked on at OfficehubTech: ✅ Claude + MCP Server + Zoho CRM This integration connects Zoho CRM with Claude AI through our custom MCP Server, enabling intelligent AI-driven responses

• Live webinar: Power-up your business presentations with Show's add-ons

  We all spend a good amount of time building presentations for meetings, reports, and pitches. But even with good content, slides can sometimes feel basic or less engaging. That’s where having the right tools helps. With Zoho Show’s add-ons, you can embed

• Zoho Inventory Feature Roadmap Visible To All

  Hello, please consider making your feature roadmap visible to us users so that we know what to expect in future. This may appease current users who are seeking clarification on feature implementation dates, so that they can make an informed decision whether

• Data Template Amending

  Hi, is it possible to remove data templates once you have applied them in Workdrive? Also, once I have added a new field to a data template can I mass update multiple files who have already been allocated that template and amend just that one added

• Upcoming Changes to LinkedIn Parsing in Resume Extractor

  Starting 31 July 2025, the Zoho Recruit Resume Extractor will no longer support direct parsing of candidate data from LinkedIn profiles. Why Is This Change Needed? In accordance with LinkedIn’s platform policies, extracting profile data through browser

• Writer very buggy and glitchy after only a few minutes of use... oh my.

  I am finding Writer to be very buggy and glitchy while using it. I've tried it in Firefox, Chrome, Safari... all Mac. Complete words get deleted on backspace (probably a feature, but disconcerting and bad design, esp. if you just want to delete a couple

• 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

• Next Page