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

• 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

• Cliq Bots - Post message to a bot using the command line!

  If you had read our post on how to post a message to a channel in a simple one-line command, then this sure is a piece of cake for you guys! For those of you, who are reading this for the first time, don't worry! Just read on. This post is all about how

• Recent Topics

• Kaizen #63 - Layout Rules in Zoho CRM

  Hello and welcome to another week of Kaizen! This week, we will be discussing Layout Rules in Zoho CRM. If you need to modify the layout of a module based on user inputs, or to show or hide sections based on the value of a specific field, we have got

• Can Zoho CRM JS SDK Send Notifications, Create Tasks & Calendar Events?

  Hello everyone! I’m just starting to explore this topic, so please excuse my beginner-level questions! Is it possible to use the JS SDK (https://help.zwidgets.com/help/latest/index.html) to: Send messages (signals, notifications) to specific employees,

• Unable to import canvas template to canvas forms

  I'm unable to import exported canvas template to canvas form, the canvas form not recognizing the template code plus the canvas import prompt title is (Create your own form page) instead of import, find the attached screenshot Please advise

• Remote Control Functionality During Screen Sharing in Zoho Cliq

  Hello Zoho Cliq Team, We would like to request the addition of remote control functionality during screen sharing sessions in Zoho Cliq. Currently, while screen sharing in Cliq is very useful, it lacks the ability for another participant to take control

• Power of Automation :: Automatically Approve/Reject the associated timelogs of Issues

  Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate

• Zoho Desk iOS and Android app update: Attachment restriction

  Hello, everyone! We are excited to introduce an option to restrict uploading certain attachment types on the Zoho Desk app. This feature allows you to specify the types of attachments are allowed to be uploaded and shared within the Zoho Desk. This can

• Zoho CRM Outlook integration: no option showing up even after installation

  I followed the instructions on this page to install the add-in: https://help.zoho.com/portal/en/kb/crm/integrations/microsoft/ms-outlook-add-in-for-zoho-crm/articles/outlook-add-in-for-zoho-crm#Understanding_the_add-in But I don't see the options in Outlook

• Portal URL Not Working?

  When I view my Company Profile, it shows my portal URL as being not created although it has been.  For example my profile shows the following:  https://meeting.zoho.com/a/..  The directory name that I chose is missing and it appears that I need to create a new Portal URL although one already exists for my organization. When I try to visit the URL that I previously created, I receive a "Page Not Found" error.

• Improve user efficiency with Automated reminders

  When it comes to business, keeping up with the deliverables is imperative. Automated reminders help you just with that, allowing you to set up notifications that are automatically triggered to your workspace users to remind them about important updates,

• Setup Outlook for domain email address fails

  I am trying to setup outlook for one of my domains email addresses and I am unable to add the account in Outlook I get "Operation could not be completed" errors. I am using the imap.zoho.com 993 for incoming and smtp.zoho.com 465 for outgoing email. I

• Free webinar alert! Empower Customer Experience in a Changing World with Zoho Desk and Zoho Workplace

  Hello Zoho Workplace Community! We’re back with another exciting webinar—and this time, it’s all about delivering exceptional customer experiences. Join us for "Empower Customer Experience in a Changing World with Zoho Desk and Zoho Workplace," where

• Date & Time Field | Minimum 24 hour notice.

  I'm trying to use Zoho Forms to build a booking request form. I have the date and time field selected as the field users can select their booking time for. My issue is I need a minimum of 24 hour notice for each appointment. I have it sent to only future

• Auto-sync field of lookup value

  This feature has been requested many times in the discussion Field of Lookup Announcement and this post aims to track it separately. At the moment the value of a 'field of lookup' is a snapshot but once the parent lookup field is updated the values diverge.

• Bigin iOS app update - Introducing Card Scanner and initiating WhatsApp conversations using pre-approved templates.

  Hello everyone! In the latest iOS (v1.11.3) version of the Bigin app, we have introduced the following features: Card Scanner Initiating WhatsApp conversations. Card Scanner: Our new Card Scanner feature extracts contact information from business cards.

• Check out in Meetings

  Why there is no check out in Meetings of Zoho CRM, very difficult to track

• Connecting Portals from different Zoho apps

  Hi, I note that Zoho has functionality for customer portals for several of the Zoho apps, like CRM, Projects, Desk etc. Is there any way to connect these portals?  It would be great if we could give our customers access to a portal in which they could

• Automate Note Creation for Service Appointments

  Hi Latha, I hope you're doing great. Thank you for your continued support in helping resolve previous issues — it's truly appreciated. I'm currently working on automating another workflow using Deluge in the Service_Appointment module. Specifically, I

• Creating Email template that attaches file uploaded in specific field.

  If there's a way to do this using Zoho CRM's built-in features, then this has eluded me! I'm looking to create a workflow that automatically sends an email upon execution, and that email includes an attachment uploaded in a specific field. Email templates

• Default Lookup Field Value based on Picklist

  How do I change a lookup field value based on another field's value, while creating/editing a record using form? I have a picklist of different types of Loans. For example: PPP, EDIL, Term, etc. When I create a record using the form, if I choose PPP from

• Portal permission for report only

  Hello, I have a hard time setting portal permission for my users. I have a form that is an order subform for items. I use that subform to create a filtered report for sellers to see their own orders, but at the same time I have to give them access to

• How to modify query from a DataBridge Connection

  Hello, I just installed the new DataBridge tool to import data to our Zoho Analytycs account from our local database. It works well so far, and data gets sync every day. The only issue that I found is that we do not know how to modify the query that imports

• Duplicating Forms doesn't duplicate Forms attachment path to workdrive

  Hi, I have this user, who uses one forms and duplicates it when needed and update the content. For him, it's important to have the submission forms saved in a specific folder inside Workdrive (as this PDF is transmitted later to another team). However,

• Add Lookup Field in Tasks Module

  Hello, I have a need to add a Lookup field in addition to the ones that are already there in the Tasks module. I've seen this thread and so understand that the reason lookup fields may not be part of it is that there are already links to the tables (https://help.zoho.com/portal/en/community/topic/custom-fields-on-task-module).

• Tip of the Week #55 – Assign roles to inbox members

  Ever heard the phrase, "Right people, right access"? That’s exactly what you can achieve in Zoho TeamInbox by assigning roles to your inbox members! In any team, not everyone needs the same level of access to your shared inboxes. Some members may need

• iOS 18 is here! Discover the enhanced Bigin app with iOS 18, iPadOS 18 and macOS Sequoia.

  Hello, everyone! We are excited to be back with new features and enhancements for the Bigin app. Let us take a look at the new iOS 18 and iPadOS 18 features. The following is the list of features covered in this update: Control widgets. New app icons.

• Basic Lookup Field Update Function

  Hi! So I have no idea what I'm doing in Deluge but I need to get a custom function to run On Create or Edit that sets the value of a Lookup Field based on the contents of another field. Seems simple enough, but I have looked through dozens of other similar

• Fourth Insight - The power of Multi-Layouts

  The Wheels of Ticketing - Desk Stories The power of Multi-Layouts In the previous insights, we have established that layouts are the foundation for a ticketing system, and fields are the building blocks for the same system. Fundamentals of layouts Fields

• Filter Multi-Line Properties with Plain Large Text

  To be able to filter fields that feature Plain large text, I am only able to filter on plain small text when you offer 3 separate options.

• 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

• App Crash on MacBook Pro

  Hi Zoho, I am still struggling to keep Zoho Notebook stable on my Mac platform. I have sent in a couple of crash logs and I am making sure I have the latest version from the Mac App store. I love this application and really want to get it stable. The

• Share saved filters between others

  Hi, I am in charge to setup all zoho system in our company. I am preparing saved filters for everybody, but the only one can see its me. How can others see it? Thanks

• Possible to reorder Pipelines position?

  I have multiple Pipelines and want to reorder their positions, so that in the Deals module record for the Pipeline field, I have them ordered in a certain way. Is there a way to reorder the position of the Pipelines without deleting existing Pipelines

• Unable to invite contacts

  Hi! I'm unable to invite contacts as end-users from my trial account. The green pop-up displays "Invited succesfully" but the email never arrives, nor the re-invitation - even though it's "sucessfully" as well. Tried with several e-mail accounts, even

• ZOHO BOOKS - RECEIVING MORE ITEMS THAN ORDERED

  Hello, When trying to enter a vendor's bill that contains items with bigger quantity than ordered in the PO (it happens quite often) - The system would not let us save the bill and show this error: "Quantity recorded cannot be more than quantity ordered." 

• Automating Sales Order Confirmation & Picklist Generation in Zoho Inventory

  Hi everyone, I’m looking to automate the sales order creation and confirmation process in Zoho Inventory, along with the automatic generation of picklists with bin-level details. Here’s what I need: Sales orders should be automatically created and confirmed

• Parent-Child Tickets using API or Deluge

  Hi Everyone, We are looking at the parent-child ticketing features in Zoho Desk. We want to be able to create a parent ticket at customer level and nest child tickets underneath. The issue we are facing is to be able to automate this. I'm checking the

• Spotlight series #7: Path animation

  Animating objects on your slide helps make your presentations lively and interesting. Animations add movement to an otherwise static deck, which helps grab your audience's attention. While you can animate your objects' entry and exit, or use animation

• Generate Unique Customer ID for Each for All Contacts

  Generate Unique Customer ID for Each for All Contacts

• Zoho Thrive is getting a revamp: Here’s what’s changing

  We’re excited to bring you an upgraded Zoho Thrive experience! This update features a more intuitive interface, improved navigation, and enhancements to help you manage your affiliate and loyalty programs with ease. What’s new? A more flexible start:

• Does Zoho Learn integrate with Zoho Connect,People,Workdrive,Project,Desk?

  Can we propose Zoho LEarn as a centralised Knowledge Portal tool that can get synched with the other Zoho products and serve as a central Knowledge repository?

• Next Page