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

• Customer payment alerts in Zoho Cliq

  For businesses that depend on cash flow, payment updates are essential for operational decision-making and go beyond simple accounting entries. The sales team needs to be notified when invoices are cleared so that upcoming orders can be released. In contrast,

• 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

• Recent Topics

• Global Search placement in the new UI

  Having a hard time with the global search placement in the UI redesign. Surely I can't be the only one. Previously global search placement was perfect. A bar at the top/center of the page. Exactly where you would expect it to be. Since the new UI has

• Dynamically Fetching Lookup Field Display Value

  I have an audit trail form, Audit_Changes, that tracks old vs new values across different forms. For lookup fields, the old/new value is the ID, but I also need the display value. What's a best practice for dynamically fetching the display value of the

• CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

  Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files

• InvokeURL butchering JSON for OpenAI API calls

  My organization works with mostly educational institutions. We have a custom module called "Schools", which is the user-entered school name they put when using our service (which they enter along with their state and zip code). We want to map this to

• Is it possible to pull the Zoho desk data into Zoho analytics in real time

  Hi - I am looking to add more dashboards and reports of Zoho Desk in analytics. I see there is a schedule to pull the data into analytics, but I'm wondering if there is an option to pull the data in real time instead of a specific interval?

• Contact's title in "Contact Role Mapping"

  When I'm creating a deal, I'd like to see the contacts title in the listing. Right now, I only see this: How can I get the contact's title in there?

• Microsoft Teams now available as an online meeting provider

  Hello everyone, We're pleased to announce that Zoho CRM now supports Microsoft Teams as an online meeting provider—alongside the other providers already available. Admins can enable Microsoft Teams directly from the Preferences tab under the Meetings

• Account in Quick View Filter

  I have a report that I often run against a specific Account. Every time, I have to go into the edit menu and change the Advanced Filter. I would prefer to use the Quick View Filter, but it does not allow me to use the one and only field that makes any

• Account in Quick View Filter

  I have a report that I often run against a specific Account. Every time, I have to go into the edit menu and change the Advanced Filter. I would prefer to use the Quick View Filter, but it does not allow me to use the one and only field that makes any

• Ability to Create New Items When Zoho Trident is Minimized via tray or taskbar icon

  Allow users to create new items (emails, calendar events, tasks, etc.) directly from the system tray icon or by right clicking the task bar icon, even when the window is minimized or not actively running in the foreground. This enables quick access to

• Bug Report and Suggestions for Improvement in Zoho Applications

  Hi Zoho Team, I’d like to report a few bugs and improvement suggestions I’ve noticed while using Zoho products: Zoho Cliq Video Call: The camera sometimes turns off automatically during video calls. This seems to be a bug — please check and fix it. Zoho

• Enhancements to the formula field in Zoho CRM: Auto-refresh formulas with the "Now" function, stop formula executions based on criteria, and include formulas within formulas

  Dear Customers, We hope you're well! By their nature, modern businesses rely every day on computations, whether it's to calculate the price of a product, assess ROI, evaluate the lifetime value of a customer, or even determine the age of a record. With

• I can not see Undeliverable emails from my Mass Email Leads activity in CRM

  I am sending email templates and I can not see the Undeliverables? I only receive the "Out of Office" replies and any manual replies from the lead. Can you please let me know where the Undeliverable emails are sent so I can use the information to clean up the database?

• Select Zoho Contacts as Meeting Participants in Zoho Cliq

  Hello Zoho Cliq Team, We hope you're doing well. We would like to request an enhancement to the meeting scheduling functionality in Zoho Cliq. Current Limitation: When scheduling a meeting in Zoho Cliq, participants can only be selected from: Organization

• Creating Secret via Vault API

  Hi I am trying to create a secret through vault api.  This is the response I get. One thing I am not sure is how to decrypt the secretdata, how to get the secrettypeid? {     "operation": {         "result": {             "error_code": "",             "message": "Sorry, we are unable to process your request.",

• Ability to Select External Users from Participants List When Scheduling Meetings

  Hello Zoho Cliq Team, We hope you're doing well. We would like to request an enhancement to the meeting scheduling experience in Zoho Cliq. Current Limitation when scheduling a meeting in Zoho Cliq: External users can be selected from the list only under

• Kaizen #212 - Map Dependency Fields in Zoho CRM using APIs

  Welcome back to another week of Kaizen! Over the past few weeks, we have been addressing your questions and feedback shared through our Kaizen 200th feedback form. Thank you for your continued engagement and thoughtful queries. We truly enjoy helping

• Enhancing Zia's service with better contextual responses and article generation

  Hello everyone, We are enhancing Zia's Generative AI service to make your support experience smarter. Here's how: Increased accuracy with Qwen One of the key challenges in AI is delivering responses that are both contextually accurate and empathetic while

• CRM for email in Outlook: how to ignore addresses?

  We’re using the "Zoho CRM for email" add-in for Outlook. When opening an email, the add-in displays all email addresses from the message and allows me to add them to the CRM or shows if they’re already contacts. However, sometimes people listed in To

• Zoho Sign Reminder email template

  Is there a template we can edit for the reminder emails? I don't see it in Settings / Choose a template

• Outdated state in mexico

  Hello Zoho team, the drop down to add the state for customers, when they introduce their state in mexico has a city named “Distrito Federal” that name changed many years ago to “ciudad de mexico”. could you please update this so my clients can find the

• Is anyone using Zoho Flow with airtable?

  I need to build a flow that collects data from airtable and uses some of that data to create folders and files in google drive. I have fully function version of this in zapier and want to migrate to zoho. I am trying to perform a very basic fetch from

• Default in fields on Form B based on the user selection in Form A

  Hi Everyone, I have added an action button to a form report to bring up a new form based on user selection, see it indicated in red below: Then when the ne form loads, I want to default in some of the fields based on the record the user was selected on.

• SOME FEATURES ARE NOT IN THE ZOHO SHEET IN COMPARISION TO ZOHO SHEET

  TO ZOHO sir/maam with due to respect i want to say that i am using ZOHO tool which is spreadsheet i want to say that some features are not there in zoho sheet as comparison to MS EXCEL like advance filter and other Features which should be there in ZOHO

• Organization Emails in Email History

  How can I make received Org Emails to show up here?

• AI in Zoho Workplace: A Sneak Peek into What’s Coming!

  Hello everyone, We’re super excited to share something we’ve been working on and we want you to be part of it! You may have seen our announcement blog post introducing a major evolution in how AI works within Zoho Workplace. Want to be among the first

• Display Client Name in Zoho Creator Client Portal Dashboard

  Hello Zoho Creator Team, We hope you are doing well. Zoho Creator recently introduced the option to set a client’s display name in the Client Portal settings, which is very helpful for providing a personalized portal experience. However, there is currently

• Meet Canvas' Grid component: Your easiest way to build responsive record templates

  Visual design can be exciting—until you're knee-deep in the details. Whether it's aligning text boxes to prevent overlaps, fixing negative space, or simply making sure the right data stands out, just ironing out inconsistencies takes a lot of moving parts.

• Migrate file from Single File Upload to Multi File Upload

  Dears, I have created a new field Multi File Upload to replace the old Single File Upload field. I'd like to ask you guys what is the best way to migrate the files to the new field?

• Best way to share/download presentation files in Zoho without losing formatting?

  Hello Zoho Community, I often work with PPT/PDF files in Zoho Docs and share them with colleagues. While PDFs usually give a direct download option, I’ve noticed that PPT/PPTX files sometimes only open in the viewer without a clear download link. Is there

• Workflow Failure - Notifications

  Good afternoon, I have just experienced an error whereby a Workflow failed, for a reason currently unknown. The problem is that one of my users had to flag this manually (thankfully he's very thorough) and this otherwise would have flown under the radar.

• Introducing Bin Locations In Zoho Inventory

  Hello users, We are excited to let you know that your wait for the Bin Locations feature has now come to an end! Yes, you heard us right! We are here to introduce the much-awaited Bin Locations now in Zoho Inventory. But before we dive into the feature

• Error "Invalid client task found corresponding properties" only when triggered from workflow ?

  Hi All, I am facing an error message I never encountered previously: Error in executing On Add - On Load script Error in executing thisapp.get_all_projects_api_call function. Line:(2) Error in executing thisapp.getAccessTokenFromRefreshToken function.

• How to setup pricing in Zoho

  Hi everyone, I am relatively new here and have just moved from my old inventory system to the Zoho one. I am trying to get my head around how it all works. I am mostly setup connected to a shopify store, but I do manual sales also For manual invoicing,

• Is it possible to create a word cloud chart in ZoHo Analystics?

  Hi there, I have a volume of transaction text that I would like to analyse using word cloud (or other approcah to detect and present word frequency in a dataset). For example, I have 50,000 records describing menu items in restaurants. I want to be able

• How to interpret Campaign report statistics - definitions/explanation

  I am trying to make sure I understand the Campaign report correctly Do you have a list of definitions for: Delivered - it has reached the recipient's inbox Campaign reach - is this the number that have opened the campaign email? Unique Opens Clicks/Open

• Add Custom Reports To Dashboard or Home Tab

  Hi there, I think it would be great to be able to add our custom reports to the Home Tab or Dashboards. Thanks! Chad

• Feature request - pin or flag note

  Hi, It would be great if you could either pin or flag one or more notes so that they remain visible when there are a bunch of notes and some get hidden in the list. Sometimes you are looking for a particular name that gets lost in a bunch of less important

• How do I filter contacts by account parameters?

  Need to filter a contact view according to account parameter, eg account type. Without this filter users are overwhelmed with irrelevant contacts. Workaround is to create a custom 'Contact Type' field but this unbearable duplicity as the information already

• Maximum limit of rows exceeded

  I am trying to add a row to a spreadsheets that has fewer than 60 rows. I keep getting an error message that says I have exceeded the maximum limit of 65,536 rows. Any ideas out there?

• Next Page