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
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 #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 areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over theKaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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.
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
Integrate Projects for Desk KB article release tasks
Could you please look into the possibility of integrating project tasks for Zoho Desk article release processes? We are looking for an internal integration between Zoho Projects and Zoho Desk's KB article drafting, reviewing and releasing tasks. We couldIssue in Annual Leave
We created a policy to credit 21 days at the Start of the Year An employee has taken 16 days of leaves thought the year, so we expect to see 5 Leaves remaining right? But Zoho People is Showing 12 Days of Leave Balance Available If we check the LeaveUse the searchBy parameter to find user by email address
I'm trying to find a user is Zoho Desk via the Api. In the documentation I see that there is the possibility to add a searchBy parameter in the request. But I can't find how the search values should be formatted. I've tried multiple things and get eitherZoho CRM Community Digest - September 2025 | Part 2
Hello Everyone! Mid-September vibes: fresh tips, smart hacks, and practical Zoho CRM updates all in one place. Let’s dive in. Product Updates: The All-New Address Field! The new Address field type makes it easier to capture complete addresses in one structuredZoho Vault API: Create new Secrets
Hello, I attempt to Post Secrets to the vault, since the encrypted entries are almost impossible to decrypt, since there is no documentation on how to decrypt them. Like with the lack of documentation on how to descrypt, there are missing information regarding on how to create new secrets/post secrets. Source: https://www.zoho.com/vault/api/#create-a-new-secret When I try to send JSON Informationen as a POST-Request I only receive the error message: { "operation": { "result": { "error_code": "",CRM and Finance Tab - Add Invoice "Subject " Column
When On a contact in CRM, and you click the Zoho Finace tab, how can I put in the invoice subject line? Or even a custom field for this. We need to see what that invoice is for, without opening it. If we have tons of invoices we need a way to quickCollections Management: #4 Before, During & After Payment Processing
"Mark, I think the payment link isn't working. Can you send it again?" Staring at a message, Mark got on his phone. This was the third time the same customer had asked him that week. A few minutes later, another message came, "Hey, the invoice total seemsAccount name not populating when importing contacts
When importing a csv file to add contacts the account name is blank? Every other filed gets mapped and imported correctly, i.e contact name, phone number. However not the account name which I have mapped to "company" field in my csv fileSuggestion to improve zoho writer
I am using your product, I believe it is very useful, however, i was writing a note and I needed to draw an arrow in different angles to explain a point and I couldn't. it would be helpful, to add draw functions to the zoho writer. thanksAlmost all Flows are being queued
A few days ago I saw one of my Flows status was Queued. This was the first time this had ever happened. Now, almost every Flow that triggers is Queued for at least a few minutes. If I re-trigger the Flow (which causes separate problems) they sometimesZoho Analytics & Zoho Creator - Modified Time value
I'm trying to use the Zoho Creator system field 'modified time' in Zoho Analytics, but it's consistently showing 12 hours 'out' In Zoho Creator In Zoho Analytics Is this a constant difference that I just need to correct with a timezone change - or iswebhook basic authentication
II want to use a webhook to send out a SMS. Unfortunately Twilio does not use an authToken but basic authentication. I created the webhook as POST and get this url: https://{username}:{password}@api.twilio.com/2010-04-01/Accounts/{account}/Messages?body=<BODY>&to=+155555555&from=+1555555555Managing functions
Can someone let me know if there are any plans to improve the features for managing functions in CRM? I have lots of functions and finding them is hard. The search only works on the function name and the filter only works on function type. I have createdGood 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 activitiesCustom function return type
Hi, How do I create a custom deluge function in Zoho CRM that returns a string? e.g. Setup->Workflow->Custom Functions->Configure->Write own During create or edit of the function I don't see a way to change the default 'void' to anything else. AddingIssue with Hour Calculation in Zoho People Attendance Module
I have noticed an issue in the attendance regularization feature of Zoho People. When trying to regularize past dates, the total working hours are not calculated correctly. For example, if I enter a check-in and check-out time for a previous day, theFree webinar alert on November 19 - Email driven strategies - Master personality based styles
Hello Zoho Community! Want to make email management easier, smarter, and more you? We’ve got just the session for you! Join our interactive, game-based webinar to discover how Zoho Mail adapts to your personality and work style. Learn practical hacks,Push Notification for New Bookings in Zoho Bookings App
when a someone schedules an appointment through the booking page, is there any option to receive a push notification in the mobile app?Automation in Zoho Sprints
Hi. I have a Sprints board with the following statuses: ToDo, InProgress, CodeReview, Testing, Preprod, Live When a ticket is moved from e.g. Testing to Preprod, the following tags should be modified: remove 'tested OK' remove 'ready for Preprod' addExport Purchase orders as Excel
Is it possible to export purchase orders as excel rather than PDF? Our suppliers don't want orders made in PDF, they need it to be excelCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsDraft & Schedule Emails Directly in Bigin
Greetings, I hope all of you are doing well. We're happy to announce a few recent enhancements we've made to email in Bigin. We'll go over each one in detail, but here's a quick overview: Previously, you couldn't draft or schedule emails in Bigin, butCreate CRM Deal from Books Quote and Auto Update Deal Stage
I want to set up an automation where, whenever a Quote is created in Zoho Books, a Deal is automatically created in Zoho CRM with the Quote amount, customer details, and some custom fields from Zoho Books. Additionally, when the Sales Order is convertedAuto sync Photo storage
Hello I am new to Zoho Workdrive and was wondering if the is a way of automatically syncing photos on my Android phone to my workdrive as want to move away from Google? ThanksSend email template "permission denied to access the api"
Hello, Per the title, I'm trying to send a Zoho CRM Email template based on the advice given here: https://help.zoho.com/portal/en/community/topic/specify-an-email-template-when-sending-emails-in-custom-functions (I'd prefer to send right from DelugeZia’s AI Assist now helps you write clearer notes — in seconds
After helping recruiters craft job descriptions, emails, and assessments, Zia’s AI Assist is now stepping in to make note-taking effortless too. Whether you’re recording feedback after an interview or sharing quick updates with your team, you can nowAdd Prebuilt "Partner Finder" Template with Native Zoho CRM Integration in Zoho Sites To: Zoho Sites Product Team
Hi Zoho Team, We hope you're doing well. We would like to request a prebuilt "Partner Finder" template for Zoho Sites, modeled after your excellent implementation here: 🔗 https://www.zoho.com/partners/find-partner-results.html ✅ Use Case: Our organizationShortcut to fill a range of cells
Good evening: I'm writing because I haven't been able to find a feature that allows you to select a range of cells, type in one of them, and then use a key combination to type in all of them. In Excel, the keyboard shortcut is Ctrl+Enter. I haven't foundIntroducing Dark Mode / Light Mode : A New Look For Your CRM
Hello Users, We are excited to announce a highly anticipated feature - the launch of Day, Night and Auto Mode implementation in Zoho CRM's NextGen user interface! This feature is designed to provide a visually appealing and comfortable experience forObject required error
Hi, I am getting an 'Object required' error on the line Call HideColumnsOutsideRange(ws, startOfWeek, endOfWeek) when I run the ShowCurrentWeek macro but not when I run the ShowCurrentMonth macro. Any ideas? Regards, GW Option Explicit Sub HideColumnsOutsideRange(wsZoho CRM - Rename "Estimates" in CRM Finance Suite Integration to "Quotes"
I'm not sure if it's been 2 or 3 years now since Zoho Books renamed Estimates to Quotes. I still see "Estimates" in the Zoho CRM integration. Could this be added to Translation settings so that some customisation could be made on an account by accountIts 2022, can our customers log into CRM on their mobiles? Zoho Response: Maybe Later
I am a long time Zoho CRM user. I have just started using the client portal feature. On the plus side I have found it very fast and very easy (for someone used to the CRM config) to set up a subset of module views that make a potentially extremely usefulAll new Address Field in Zoho CRM: maintain structured and accurate address inputs
The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest updateNew Series Announcement - Ecommerce Marketing Tips
Running an online business is more than just having a website. It’s about getting the right customers to discover you, trust you, and keep coming back. To support your growth journey, we’re launching a weekly Marketing Tips series right here on Zoho CommerceMarketing Tip #7: Add a blog to your online store
A blog is more than content. It’s a magnet for new customers. Sharing product guides, styling tips, or industry insights through blog posts builds trust and helps you rank higher on search engines. Try this today: Write one blog post answering a commonKanban view on Zoho CRM mobile app!
What is Kanban? The name doesn't sound English, right? Yes, Kanban is a Japanese word which means 'Card you can see'. As per the meaning, Kanban in CRM is a type of list view in which the records will be displayed in cards and categorized under the givenAllow Regular Users to Directly Transfer Ownership of Files & Folders
Hi Zoho WorkDrive Team, Hope you are doing well. We would like to request an important enhancement related to file and folder ownership management in Zoho WorkDrive. At the moment, a regular user cannot directly transfer ownership of their files or foldersSTOCK history in zohosheets
is it possible to get historical stock value using stock function in zoho sheets? i could not see from and to period in the helper document.Triggering rules on lead conversion
There is no field on the Rule list for rule conversion to trigger an alert on liead conversion to a potential. I assigned a rule to file on any creation or update of a lead. The lead was changed a lead to a potential but no rule was fired. Rajesh BhadraCustomised Funnel
We are running the standard plan for our ZOHO CRM. I have been asked if there is a way to combine data from the Calls module, Deals module and Contact Module into 1 funnel, similar to the view you can get when viewing Deals By Stages, you can see theNext Page