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
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
Sticky Posts
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achieved
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep 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
Saved filters, layout rule support, related list quick navigation, and more
Hello Everyone, We're excited to share some new features and enhancements in the Zoho CRM iOS and Android apps that will improve your mobile experience. These updates will make your CRM journey more efficient and user-friendly. Here's a look at what'sPower of Automation: Automatically send an email to all portal users with today's list of Open tasks.
Hello Everyone, A Custom Function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as to when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:-Introduction of Robotics Process Automation in Zoho products
It will be great if Zoho can start advancing from automation to robotics process automation. For a start, it can be started with smart document understanding. Provide OCR engines Google cloud, Microsoft Azure Computer vision OCR, Microsoft OCR, OmnipageLock a custom field on a deal record but keep all other fields editable?
I have a custom field, which auto-populates a job number upon converting a lead to a deal but the automation breaks if someone accidentally edits that field. I want to lock that field but keep all other fields open. Is this possible? I've tried throughAdd Feature To Hide Plugin Sections On Record View
Hi team, I'm trying to help a client tidy up their CRM. When it comes to record view some sections and fields are visible no matter what Layout Rules are applies and they are not removeable from the layout editor. I would like to see an option to hideCreator Simplified #10: Predefine Form Field Values and Make Them Read-Only for Users
Hey Creators, Ready for this week's tip in the Creator Simplified series? Today, we will explore how to have read only fields in a form. Use Case: Assume a scenario where the default value for a Department field needs to be English Literature, but youfetch records from analytics table from creator
I have a creator workflow that I am working in that will compare data from within the app to a table in zoho analytics. Is there a way to fetch a record from Analytics? I have attempted a custom connector with analytics and tried to use it with invokeAbility to Change Custom View After Cadence Creation
Dear Zoho Team, I hope you are well. We would like to request an enhancement to the Cadence feature in Zoho CRM. Currently, during the creation of a Cadence, we can select a Custom View under the "Who is this for?" section. However, once the Cadence isZoho Creator Integration with QuickBooks: A Step-by-Step Guide
Introduction: Integrating Zoho Creator with QuickBooks allows you to sync your business data between the two platforms, providing a seamless experience for managing accounting, invoicing, and financial data. This integration helps automate workflows andNote not being pulled for other modules in email template
Hi there, Currently i am creating an email template that is able to pull the data from notes field in estimate module and email it to procurement team where they will be able to receive the email with the contents of the note, i am unable to replicateNo Sales Returns on SO's with Dropped Shipped items + Inventory Items
We have encountered an issue in Zoho related to sales orders that include both dropshipped items and inventory items. Specifically, it is currently not possible to create sales returns for the company’s own inventory items from these sales orders. ThisPick list - Cannot save list "Special Characters not Allowed" error message
Bulk uploading values. All values are pretty standard - with the exception of a "-" (dash). Like: Industry - Prepared Food Is the simple dash a special character too? JanMaking the Resolution Tab Mandatory
Hello Everyone! This edition is here to show you how to make the Resolution mandatory when closing a ticket. The Ticket Resolution tab helps keep a record of the solution provided for the ticket query. The resolution can serve as a quick reference toIs this possible with Campaigns?
My company is currently moving CRM's from Monday to Zoho One. Currently, our marketing lead process is send out 7 sms messages over 14 days if the lead is in a certain status. If we don't get a response the lead is put into a "Closed" status. Do we buyNotificación de cumpleaños
Hola: Se puede enviar alguna alerta de felicitación al personal que cumple años, que se dispare solo? Si existe como se puede hacer? SaludosAutomation#25: Move Tickets to Unassigned When the Owner Is Offline
Hello Everyone, Welcome to this week's Community Series! 'Tis the holiday season—a time when work often takes a brief pause. The holiday spirit is in full swing at Zylker Techfix too, with employees taking some well-deserved time off. During this period,Callback URLs
I need to connect to an external service through an API that requires me to provide a Callback URL so that a status update can be sent back when the API request has been processed. Is there a way to do this in Creator without having to use a middlewareEmail signature not being included if user creates ticket / sends email
When I create a ticket (send email), the signature doesn't appear to be added to the ticket. Can you confirm if this is the case? It would obviously be useful to include the user's signature even when sending a client an email and not only on replieZoho Notebook window ignores taskbar
When maximized to full screen, the Zoho Notebook window ignores the presence of the taskbar and overlaps it. What could be the problem? Linux Mint 22 Cinnamon. Zoho Notebook 3.2.0URL for job opening
I would like to ask you to add this feature to the product: create an unique url for each job opening on Zoho Recruit, so that I can add a link to it when I post the opportunity in a mailing list or on a forum.Document images
We used to be able to rotate the images but this has now been removed ???VENDORS ARE NOT SYNCHED WITH CONTACTS IN CRM
Hello, While the ACCOUNTS and CONTACTS (Including the primary contact) are synced with the CONTACTS module in CRM, the vendor's CONTACTS are not synced with CRM - which basically forces the users to re-enter all vendor's contacts twice and then updateOne license but several mailboxes for one person
Hello, I am interested in getting a Zoho One license. Unfortunately, there is one major issue with the pricing. I am only one person using the Zoho apps. I plan to use them as individual entrepreneur. Although I need several mailboxes in Zoho mail forInvolved account types are not applicable when create journals
{ "journal_date": "2016-01-31", "reference_number": "20160131", "notes": "SimplePay Payroll", "line_items": [{ "account_id": "538624000000035003", "description": "Net Pay", "amount": 26690.09, "debit_or_credit": "credit" }, { "account_id": "538624000000000403", "description": "Gross", "amount": 32000, "debit_or_credit": "debit" }, { "account_id": "538624000000000427", "description": "CPP", "amount": 1295.64, "debit_or_credit": "debit" }, { "account_id": "538624000000000376", "description":KB Templates
* It would be nice if Zoho can provide users an option to create custom templates for KB articles. Also, it would be nice as well if the users can have an option to 1.) select a default template and 2.) declare default tag/tags, for KB articles created through Ticket's resolution.Zoho CRM Reports Module on Mobil App
I have the mobile app and the reports module doesn't appear in the sidebar for some reason. I saw a Youtube video where the user had the Reports module on mobile. Is there a setting to show it on mobile? Thanks.Zoho Projects Android app update - List view enhancement
Hello, everyone! In the latest android version(v3.9.15) of the Zoho Projects app update, we have enhanced the List view of tasks. We have also introduced a complete scroll of the tasks in the list view without scrolling the task fields(status, start date,On the US Data Centre rather than the UK but dont know how to migrate it
We have a new staff member with an external email address and cant add them to Zoho chat - we have been told its becuase we are in the UK but on a US Data centre - we therefore need to change it but no idea how to can anyone else as we are going roundZoho Sheet Custom function column showing Error #EVAL!
Hello I have a custom function in Zoho Sheet developed to convert a date time from one time zone to another. The custom function takes date and time columns and then using subHour( ) converts the time to PST time. However, though the custom function works,Create Your Own Issue Management System
Effective issue management is a cornerstone of project success. Every bug or issue, no matter how small, needs to be tracked and resolved in time to maintain project momentum. In this post, we’ll explore how an issue management system in Zoho ProjectsResource utlisation
Dear Team, We use the excel for the weekly predicted people utilization how the resource are allocated , is there any way that i can use any of the zoho products.Ask the experts - A live Q & A discussion on Zoho Recruit
We are delighted to come back with another edition of Ask the Experts community series. This edition, we'll be focusing on everything about Zoho Recruit. The topics will focus on the features that are used/asked by the majority of users and also basedBug - OTP (email) and No Duplicates
Scenario: Form with an email field, Validation: "No Duplicates" (because I want to ensure 1 entry per email). Embedded form into website (JS option). Enabled email based OTP. 1st test (via my website) - entered my email address - sent OTP - entered pin,Personal Facebook page posting instead of Business Page
I have a Facebook page that is associated with my Personal Profile and I am the Admin of that Page. I would like to schedule and Post to my Personal Page not the Business Page. Each time I try to connect to the "Page" it takes me to the Business Page. Is there a way of connecting to my personal page?Recording depreciation of fixed assets as a percentage of residual value
In India, fixed assets are depreciated as a percentage of their residual value at the beginning of each fiscal year. I went through the documentation for creating recurring journal entries, but could only find ways to depreciate by a fixed rupee amountFunction #28: Automatically calculate Customer Loyalty points
Hello everyone, and welcome back to our series! Today, we're excited to share a workflow designed to streamline the management of loyalty points. Many businesses offer incentives or rewards in the form of loyalty points to their customers as a way toFunction #6: Calculate Commissions for paid invoices
Zoho Books helps you automate the process of calculating and recording commissions paid to sales persons using custom functions. We've written a script that computes the commission amount based on the percentage of commission you enter and creates anHow to Add Product SKU in Invoice?
How to Add Product SKU in Invoice?Tracking movement between departments
I've been developing a reporting system in Zoho and one of the groups I want to develop a report on primarily moves tickets from department to another. Is there a way to set up the reporting on Zoho (or Zoho Reports) that can tell me the number of ticketsZoho CRM Calendar View
Hello Zoho team, We need desperately a calendar view next to list, kandan and other views. I think it should be easy to implement as you already have the logic from Projects and also from Kanban View in CRM. In calendar view when we set it up - we chooseNext Page