Kaizen #8 - Handling Recurrence and Participants in the Events Module via API
Hello everyone!
We are back this week with an exciting post—Handling recurrence and participants in the Events module through API.
First things first—What is the Events module?
"Events" is a part of the Activities module in Zoho CRM.
An event is an activity that happens at a given place and time. You can find Events on the user's Zoho CRM's home page, Activities home page, Calendar, and in other related records.
What are the types of Events?
Events are of two types—Recurring and non-recurring events.
Recurring events: These events repeat/recur at a set frequency. You can set them to repeat by day, week, month, or by year. You can also set them to repeat a fixed number of times.
Non-recurring events: These are one-time events.
Both these events can also be all-day events.
Now, let us see how to handle a recurring event and add/update participants via API.
1. Creating a Recurring Event through API
You must use the Insert Records API to insert a record in the Events module.
Request URL: {{api-domain}}/crm/v2/Events
Request method: POST
Sample input to create a recurring event that repeats every two weeks
{ "data": [ { "All_Day": false, "Event_Title": "Kaizen_9_Weekly", "Start_DateTime": "2020-02-02T10:00:00+05:30", "End_DateTime": "2020-02-02T11:00:00+05:30", "Participants": [ { "type": "contact", "participant": "3652397000001281003" }, { "type": "lead", "participant": "3652397000000415063" }, { "type": "user", "participant": "3652397000000186017" } ], "Recurring_Activity": { "RRULE": "FREQ=WEEKLY;BYDAY=SU;INTERVAL=2;UNTIL=2020-03-15" }, "Remind_At": "2020-02-01T09:45:00+05:30", "Who_Id": { "id": "3652397000000649013", "name": "Patricia Boyle" }, "Venue": "Chennai", "$se_module": "Accounts", "What_Id": "3652397000000624046", "$send_notification": true } ] } |
Mandatory keys
The following table lists the mandatory fields you must specify while creating a recurring event. Not including any one of these fields results in the MANDATORY_NOT_FOUND error.
Key | Data Type | Description |
Event_Title | String | Title of the event. Accepts a maximum of 255 characters, alphanumeric, and special characters. |
Start_DateTime | DateTime | The date and time (in ISO8601 format) at which the event begins. |
End_DateTime | DateTime | The date and time (in ISO8601 format) at which the event ends. |
Recurring_Activity | JSON Object | JSON Object that contains information about the recurrence pattern of the event in the key "RRULE". |
Other Keys
Key | Data Type | Description |
All_day | Boolean | Represents if the event takes place all day. |
Participants | JSON Array | Contains the ID and type of each participant in individual JSON objects. Possible participant types are "lead", "contact", "user", and "email". |
Remind_At | DateTime | The date and time in the current user's time zone (in ISO8601 format) at which a reminder is sent to the participants. |
Who_Id | JSON Object | The name and ID of the contact that the event is related to; that contact may or may not be a participant of the event. |
What_Id | JSON Object | The name and ID of the Account, Deal, Product, Quote, Invoice, Campaign, Vendor, Case, Purchase Order, or Sales Order that the event is created for. |
$se_module | String | The API name of the parent module given in the key "What_Id". This key is mandatory when you include the "What_Id". |
Venue | String | The place where the event takes place. Accepts a maximum of 255 characters, alphanumeric, and special characters. |
$send_notification | Boolean | Represents if you want to send invitations to the participants of the event. The value true sends out invitations, and false does not. |
We will now discuss the Participants and RRULE keys in detail.
1.1 Participants
The Participants key is a JSON array of participant JSON objects. You can add four types of participants to an event—lead, contact, user, and email.
You must include each of these participant types as individual JSON objects inside this array as shown below.
"Participants": [ { "type": "contact", "participant": "3652397000001281003" }, { "type": "lead", "participant": "3652397000000415063" }, { "type": "user", "participant": "3652397000000186017" |
Where,
type - The type of participant. The possible values are lead, contact, user, email
participant - The record ID of the lead, contact, or user.
1.2 RRULE
RRULE is the key in the Recurring_Activity JSON object that determines the recurrence pattern of the event.
RRULE holds multiple key-value pairs for different types of recurring events (i.e Daily, Weekly, Monthly, Yearly). You must separate each key-value pair by a semicolon.
Mandatory key-value pairs for RRULE
Key | Possible Values | Description |
FREQ | DAILY, WEEKLY, MONTHLY, YEARLY | Frequency; represents how often the event repeats. |
INTERVAL | 1–99 | The gap between each event. For example, for a weekly recurring event, if the INTERVAL value is 2, the gap between the first and the next event will be two weeks. |
COUNT | 1–99 | The number of events you want to create. For example, if the COUNT value is 3, three events will be created. |
Note
You must specify FREQ and (INTERVAL or COUNT) in RRULE.
Other key-value pairs in RRULE
Key | Possible Values | Description |
BYMONTHDAY | 1–31 | The day of the month the event repeats on. Applicable only for monthly and yearly events. |
BYDAY | SU, MO, TU, WE, TH, FR, SA | The day of the week the event repeats on. Applicable for daily, weekly, monthly, and yearly events. |
BYSETPOS | 1, 2, 3, 4, -1 | The week of the month the event repeats in. Applicable only for monthly and yearly events. 1 - Event repeats every first week of the month 2 - Event repeats every second week of the month 3 - Event repeats every third week of the month 4 - Event repeats every fourth week of the month -1 - Event repeats every last week of the month. |
UNTIL | Date in yyyy-MM-dd format | The date until which the event must repeat. |
Therefore, according to the sample input given at the beginning of the post, the event starts on Feb 2, 2020 at 10:00 AM and ends the same day at 11:00 AM.
According to "RRULE":"FREQ=WEEKLY;BYDAY=SU;INTERVAL=2;UNTIL=2020-03-15", the event occurs every Sunday, with an interval of 14 days (2 weeks), and recurs until Mar 15, 2020.
Therefore, the sequence is as shown below.
- The event begins on Feb 2, 2020.
- The first recurring event happens on Feb 16, 2020.
- The second recurring event happens on Mar 1, 2020.
- The last recurring event happens on Mar 15, 2020.
Therefore, the response will have four JSON objects—one for the first event as specified in the Start_DateTime key, and one for each recurring event.
Note
You can only create one set of recurring events using the RRULE in a single API call.
A few other examples of RRULE:
- "RRULE": "FREQ=MONTHLY;COUNT=3;BYDAY=WE;BYSETPOS=2".
This RRULE creates three events that recur every Wednesday in the second week of the month. - "RRULE": "FREQ=MONTHLY;INTERVAL=2;COUNT=3;BYMONTHDAY=14".
This RRULE creates three events that recur on the 14th day of the month, and repeat once in two months.
2. Updating an Event
In this section, we will discuss
- Adding a participant to an event
- Updating all future events
2.1 . Adding a participant to an event
Details you need to add a participant to an event
- The event's record ID. You can obtain this from the response you received while creating the event.
- The ID of the participants that are added already. The GET Specific Event response will have a unique ID for each participant in the "Participants" JSON array.
The sample input is as follows.
{ "data": [ { "All_Day": false, "Event_Title": "Kaizen_10_Weekly", "Start_DateTime": "2020-02-02T11:00:00+05:30", "End_DateTime": "2020-02-02T12:00:00+05:30", "Participants": [ { "type": "contact", "participant": "3652397000001281003", "id": "3652397000001326102" }, { "type": "lead", "participant": "3652397000000415063", "id": "3652397000001326100" }, { "type": "user", "participant": "3652397000000186017", "id": "3652397000001326098" }, { "type": "email", "participant": "john-butt@gmail.com" } ], "Remind_At": "2020-02-01T10:45:00+05:30", "$send_notification": true } ] } |
As you can see, a new participant of type email and email ID john-butt@gmail.com is added. Since the ID of the existing participant with the email ID carissa-batman@yahoo.com is not specified, it gets deleted.
Note
- participant is the record ID of the participant (lead, contact, or user).
- ID is the unique ID of the participant for that event.
- While adding a participant, you must specify the IDs of other participants for the event. Otherwise, only the new participant is added, while the rest are deleted.
2.1 . Updating all future events
While updating an event, you can choose to update all future events with the new change.
Use the boolean key update_all_future_events. The value true updates all future events, and the value false updates only that particular event.
Here is a sample input.
{ "data": [ { "All_Day": false, "Event_Title": "Kaizen_10_Weekly", "Start_DateTime": "2020-02-02T11:00:00+05:30", "End_DateTime": "2020-02-02T12:00:00+05:30", "Participants": [ { "type": "contact", "participant": "3652397000001281003", "id": "3652397000001326102" }, { "type": "lead", "participant": "3652397000000415063", "id": "3652397000001326100" }, { "type": "user", "participant": "3652397000000186017", "id": "3652397000001326098" }, { "type": "email", "participant": "carissa-kidman@yahoo.com" } ], "Remind_At": "2020-02-01T10:45:00+05:30", "update_all_future_events": true, "$send_notification": true } ] } |
Points to Note
While creating recurring events,
- You must specify either COUNT or INTERVAL in the RRULE. Otherwise, the system creates 365-day events.
- For WEEKLY recurring events, you must include BYDAY in RRULE. Otherwise, the system creates 365-day events that recurs weekly.
While updating a recurring event,
- You must specify the record ID of the event you want to update.
- You must set the value of the key update_all_future_events to true to update all future events. Otherwise, the system updates only that event and the other recurring events that you created previously will remain unaltered.
- While adding a participant, you must specify the IDs of other participants. Otherwise, only the new participant is added, while the rest are deleted.
- You cannot update RRULE through the API.
- You cannot update check-in related information through the API.
We hope you found this post useful. Please reach out to us if you have questions, or let us know in the comment section.
Cheers!
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
Juan
Praveen Sankar
Ramki | Nexivo | Zoho Premium Partner
Jaya Suriya J
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
emailing estimates
Shows up in the customer mail logs as sent but nobody is receiving them, even when I send them to myself I don't get them ??? Something wrong with the mail server or my end ?Powering Customer Support with our women
In Zoho Desk support, women make up 50% of our team. We see this as one of our strengths, reflecting the spirit of this year’s theme, "Give to Gain". Our women find their balance Women carry many responsibilities — they represent frontline support, leadHow to use OR when filtering using two fields
I want to create return a list of Account Names by filtering on Field1 = "yes" OR Field 2 = "no" I can't see how to use the OR in the filter.Mobile phone version not working well
I am working on the Zoho Site Builder. In the preview the desktop version looks okay, but in the mobile phone preview many words are cut off in the weirdest (wrong) way. How can I fix that?Zoho - Please explain difference between Thread view and Conversation view on Ticket
I have reviewed the help document here but am still not clear on the difference between the two views. As an example, I just had a back and forth on a ticket: - Customer emails support email. - I email back from Desk. - Customer responds back. - I email back from Desk. On the upper left drop down box on the ticket Zoho Desk now says this is "4 Threads" and "4 Conversations" . How is that 4 threads?? By my count it is 1 thread and 4 conversations (assuming by "conversation" Zoho means number of totalCan't rename groups on Mac desktop app
I'm working on an up-to-date Mac with a freshly downloaded Notebook app. I'm trying to rename a group within a notebook. Here I have, left to right, a note, a group, and a note. I select the group. On the top left, I select Action. On the dropdown, "Rename"Zoho Forms - Feature Request - Year Field
Hi Zoho Forms Team, You currently have the following date and time fields: Date Time Date and Time Year and Month It would be useful if you could include a "Year" field For example a recent application I completed said "What year was your house built?"I need help to take Reports for tickets moved between departments.
Hi, I need help to take Reports for tickets moved between different departments. Pls guide ShyamExport to excel stored amounts as text instead of numbers or accounting
Good Afternoon, We have a quarterly billing report that we generate from our Requests. It exports to excel. However if we need to add a formula (something as simple as a sum of the column), it doesn't read the dollar amounts because the export storesIncrease Round Robin Scheduler Frequency in Zoho Desk
Dear Zoho Desk Team, We hope this message finds you well. We would like to request an enhancement to the Round Robin Scheduler in Zoho Desk to better address ticket assignment efficiency. Current Behavior At present, the Round Robin Scheduler operatesAutomation #6 - Prevent Re-opening of Closed Tickets
This is a monthly series where we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Typically when a customer submitsZoho Desk EU slow/unresponsive
Has anyone else got issues with ZohoDesk today in the EU? It takes an age to come back and if you do start typing something and try and send or save it looks like it times out. We are also getting this pic. ot I can't see anything on https://status.zoho.eu/EU DC Partial Outage Resolved: A Detailed RCA
Incident Summary Due to an overload on one of the nodes in the EU DC for Zoho Desk, the system was unable to handle the heavy load, causing a slowdown in requests and resulting in a partial outage for customers with data residing in that node. On MayUse Zoho Creator as a source for merge templates in Zoho Writer
Hello all! We're excited to share that we've enhanced Zoho Creator's integration with Zoho Writer to make this combination even more powerful. You can now use Zoho Creator as a data source for mail merge templates in Zoho Writer. Making more data fromPerfomance Management - Zoho People
Hi team, I am looking for performance management data such as KRA, goals, feedback, appraisals, etc., in Zoho Analytics. However, I am unable to find these metrics while editing the setup. Could you please confirm whether these fields are available inDeprecation of the Zoho OAuth connector
Hello everyone, At Zoho, we continuously evaluate our integrations to ensure they meet the highest standards of security, reliability, and compliance. As part of these ongoing efforts, we've made the decision to deprecate the Zoho OAuth default connectorGood news! Calendar in Zoho CRM gets a face lift
Dear Customers, We are delighted to unveil the revamped calendar UI in Zoho CRM. With a complete visual overhaul aligned with CRM for Everyone, the calendar now offers a more intuitive and flexible scheduling experience. What’s new? Distinguish activitiesZoho Mail iOS app update: Display recipient's nickname on contact suggestion
Hello everyone! In the most recent version(v3.3.1) of the Zoho Mail iOS app update we have brought in support to display recipient's nickname in contacts suggestion. Please update the app to the latest version directly from the App Store or using theDigest Février - Un résumé de ce qui s'est passé le mois dernier sur Community
Bonjour chers utilisateurs, Le 26 février, nous avons organisé notre première session Ask the Expert de 2026. Nous sommes heureux de partager que ce fut une session très interactive, avec de nombreuses questions intéressantes posées par nos clients. SiZoho CRM Case Notes - Share to Customer
Hi team does anyone know the Api to set a note, against a case, to shared with customer? i cant seem to find it cheersZoho Forms - Feature Request - Past Into Scanning/OCR Field
Hi Zoho Forms Team, You recently introduced the OCR/Scanning field which I have found great use for with one client who receives work orders as a screenshot from one customer. I want to raise a feature request here which would make that field even moreSynching changes to Stripe when changes are made in Zoho Billing
We have a situation where we have merged customers in Zoho BIlling and then found out later that the payment in Stripe was not updated and still associated with the old customer record. The card gets updated and billed, but that payment is still associatedSend out follow-up email in the same thread (threaded conversations in individual emails) from Zoho CRM
Hi, I'm new to Zoho. I'm trying to send individual emails to my leads one by one. And I'll send out follow up email if I don't hear back from them later. However, instead of sending a new email, I want to reply in the same email thread so that the recipientsDepositing funds to account
Hello, I have been using Quickbooks for many years but am considering moving to Zoho Books so I am currently running through various workflows and am working on the Invoicing aspect. In QB, the process is to create an invoice, receive payment and thenIs Zoho Sites still actively being developed?
Hello, Is Zoho Sites still actively being developed as part of the Zoho ecosystem? I noticed that the What's New page (https://www.zoho.com/sites/whats-new.html) does not show any updates since Q1 2025. We were considering migrating our website from SquarespaceFSM integration with Books
Hi, I have spent a few months working with FSM and have come across a critical gap in the functionality, which I find almost shocking....either that, or I am an idiot. The lack of bi-directional sync between Books and FSM on Sales Orders/ Work Ordersweb to lead
Can anyone help me how to create web to lead from zoho marketing automationIntroducing Workqueue: your all-in-one view to manage daily work
Hello all, We’re excited to introduce a major productivity boost to your CRM experience: Workqueue, a dynamic, all-in-one workspace that brings every important sales activity, approval, and follow-up right to your fingertips. What is Workqueue? SalesUI issue with Organize Tabs
When looking at the organize Tabs window (bellow) you can see that some tabs are grayed out. there is also a "Add Module/Web Tab" button. When looking at this screen it's clear that the grayed out tabs can not be removed from the portal user's screenI created a signup form in Zoho Marketing Automation with the correct field mapping, but the data is not being reflected under Leads in Zoho CRM.
web to lead from zoho marketing automationPasted Images not being embedded in custom mail
Hi, I'm making a custom report by email based on commentaries. I have the email ready, all working great except for images that are being pasted in the commentaries. Zoho deals with them as temp images and so it requires authentication to view them, somethingKaizen #232 - Building a Ticket Escalation Mechanism from Zoho CRM
Howdy, Tech Wizards! Picking up the thread from last week, we will continue our Zoho CRM and Zoho Desk integration. In Kaizen #231 - Embedding Zoho Desk Tickets in Zoho CRM, we built a Related List widget that displays open Zoho Desk tickets within theInactive License for free account.
I recently upgraded my Cliq subscription not my team (on the free version), are unable to login to their accounts. The error message received is Inactive License Looks like you have not been covered under the current free plan of users. Please contactDeluge scripts
Why is there not a search function to make it easier to find the script of interest when modifications are required.Zoho Sheet for Desktop
Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?Zoho Books (and other Finance Suite Apps) - Clickable Item Name on Invoices and Reports
Hi Zoho Books team, It would be really helpful if the Item Name on Reports were clicable to take me to the item. The same on Invoices, often I am looking at an invoice and I want to look at the deails of a product. A link here would be helpful to jumpZoho Books - Payment Gateway - Revolut
Hi Books Team, My feature request if to include the popular platform Revolut as a payment collection option on invoices in Zoho Books. Please upvote if you are also looking for this option.Searching for an item from within an invoice should show any item containing the string, not just those that begin with the string.
Hello, I've found myself becoming increasingly frustrated with the limited line-item seach when adding new items to an invoice. The problem is that the characters being typed are only being matched from the beginning of the item name. This might be usableHow to Rank Tables by Row Count in Descending Order
I am trying to understand the consume of lines that grow up so fast in the last week. Is there any way to create a pivot table or query to get TABLE NAME LINES in descending order?Dealing With One-Time Customers on Zoho Books
Hello there! I am trying to figure out a way to handle One-Time customers without having to create multiple accounts for every single one on Zoho Books. I understand that I can create a placeholder account called "Walk-In Customer", for example, but INext Page