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 Campaigns 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
Purchase of Fixed Assets
How can I record the purchase of assets using zoho books? For example, I purchased 4 laptop for 100000 $ each and paid it through my bank account. How can I record this transaction and maintain track of how much of the assets I bought?Where is the Fixed Asset Register?
I am a Zoho One user for 18 months, using invoicing and CRM and now ready to migrate my books to Zoho Books. Where do I keep the fixed asset register for the equipment that I use in my business? I have a service based business with a lot of gear and businessKaizen #168 - Incremental Authorization
Welcome to this week's post in the Kaizen series. In this post, we will discuss Incremental Authorization. What is Incremental Authorization? Incremental Authorization is an OAuth strategy that allows a client to request specific authorization scopesConfigure Notes Title for Blueprint Transition
It'd be very helpful to be able to configure note titles on blueprint transitions when requiring notes. This would help tie back the history of notes to the blueprint actions. We have some approval processes in our blueprint and require notes for theAn update to improve email delivery | Email Authentication & Relay
Dear Zoho Recruit Community, We hope this message finds you well. This post is to inform you about an important update regarding the authentication of all email domains in your Zoho Recruit account. Effective 31st December, 2024, emails sent using emailStop adding Default ID column to xls exports
When anything is exported to xls, Zoho adds a column with an ID. WE DO NOT WANT THIS COLUMN. We use an automated report to a team. We have our own tracking number. 1. This makes the report messy, it just pushes OUR data off to the right. 2. We haveZoho cases and remote work api
How to use zoho cases listing api? When i try to hit the endpoint specified in the docs , i get the error : the page you are looking for does not exist with a 401.Calendly does not show scheduled Meetings
I use Calendly as my standard booking tool, but no matter what I am doing, Calendly shows any appointment as free (when in fact there already is an appointment in CRM Calendar or Zoho Calendar). Drives me nuts - cannot go away from Calendly due to variousI want the currency in my account to be Mexican pesos.
Hello, I am a Mexican citizen and live in Ukraine. When I registered to your system, it was seen that I was from Ukraine, so the default currency is Euro. This is causing me a problem. Please change the standard currency in my account to Mexican PesYear-End Wrap: Don't rewrite - Switch to Email Templates
As we're half-way through December, now is the perfect time to start sending out festive greetings. Whether it is to your clients or your team, it is important that every mail is tailored to the recipient and feels genuine, which allows you to make betterElevating Email Security on Zoho Desk: DKIM Now Mandatory
Hello Zoho Desk Users! It has been a wonderful journey with you on Zoho Desk. As we prepare to welcome 2025, we are strengthening our efforts to ensure a secure and seamless experience for you. To enhance email security, DKIM configuration will be mandatoryHow to view shared mailbox in Outlook
How to view shared mailbox in Outlook or in another softwareNecesito el código ZB para mi cuenta
Hice cambio de servidor y no encuentro el codigo unico de cname.Privacy error
Privacy error on Chrome for all embedded forms and reports, this is a huge issue: "Your connection is not private Attackers might be trying to steal your information from creator.zohopublic.com (for example, passwords, messages, or credit cards). NET::ERR_CERT_COMMON_NAME_INVALID"Automate Backups
This is a feature request. Consider adding an auto backup feature. Where when you turn it on, it will auto backup on the 15-day schedule. For additional consideration, allow for the export of module data via API calls. Thank you for your consideration.Customise Search Bar in CRM
Is there a way to customise this search bar in the CRM to add fields?Counting downloads of a file
Hello Could anyone help me, I would like to use a custom script to count how many times a file contained in a record has been downloaded. Is that something that is possible in Creator? Thanks EstelleIs there any way to prevent emails from being sent from zoho crm without pressing email opt out?
When I left my desk yesterday I excitedly thought I had fixed my problem, by making use of the "Inactive" field ... However after contacting the support chat, they have advised to stop emails being sent I need to update the "Email Opt Out" field - whichNew Search Function
Hey Team, The search function updated in our CRM about a week ago, so I assume it was an automated update across Zoho. It no longer displays leads/deals etc in Chronological order so that the most recently created or updated is the first to display whichNew permissions for accessing emails sent via Zoho CRM
Last modified on Nov 4, 2024: Permissions for accessing emails sent via Zoho CRM have now been extended to the IN DC. With this rollout, the feature is now available to all users across all DCs. Resources: Data sharing for emails, Configuring email composeis it possible to add more than one Whatsapp Phone Number to be integrated to Zoho CRM?
so I have successfully added one Whatsapp number like this from this User Interface it seems I can't add a new Whatsapp Number. I need to add a new Whatsapp Number so I can control the lead assignment if a chat sent to Whatsapp Phone Number 1 then assignRequest for Alerts on Workflow and Function Changes.
I want to get an alert whenever a new workflow or function is added or an existing workflow or function is edited. Is there any way to do that? I need to log all changes whenever updates are made or new ones are added.Transfer Amount from One Vendor to Another Vendor
One of the vendors, who has a balance with us, has closed the business and has started a new business; Now he wants me to transfer the outstanding from the old account to the new Vendor Account. I am trying to do this using Payment Settlement a/c, ButHow to make Branch compulsory in Zoho Books invoice?
How I make Branches compulsory in Zoho Books invoice?Regarding GST Report Issue in Zoho Books
Hi, Right now, the very important point from my end is this Zoho Books issue. Here, you can see that we have created the invoice with the items of account sales and expenses. The journal is also correct. The profit and Loss statement is also correct.Default Ship To Address on Purchase Orders cannot be different than Organization Address
Our organization address is not where we want shipments delivered, it is just a mailing address. We would like to change the Ship To address on our PO's so that by default it is our warehouse (not the mailing address). I understand that when creatingFunction #57: Automatically group items in invoices based on categories
Hello everyone, and welcome back to our series! As a business expands and new product lines are launched, it becomes important to organize the items for better inventory management. The Category field in Zoho Books helps here by allowing you to add andDifferences between Zoho Books and Zoho Billing
Without a long drawn out process to compare these. If you were looking at these Books and Billing, what made you opt for one and not the other. Thanksunable to import transactions into zoho books
I download a csv with separate columns for deposit and withdraw. The sample has zero's in the blank spaces so I ensure mine does too. When I try to import it says the fields must have values greater than zero.Zoho Forms Unable to Save Account Numbers with a Leading Zero
We are using Zoho Forms to for rental applications. It is working well, except for one thing: when a user enters their bank account information, and that account number actually starts with a ZERO (like 00123456) the Zoho form will return the value withoutHow to include GST% in PO amount?
Currently when I raise PO, the basic price of the item is used. However, the GST is not calculated and added along with the basic amount. I have added a Custom field for GST in the PO but I need Zoho Inventory to calculate the GST amount and add it with the Basic price to give me the final PO price.sitemap in zoho sites not updating
I checked my sitemap and it has not added any updates. Do I have to generate one manually all the time or is zoho sites suppose to generate and update it?I trying to connect our PM tool but API shows failure
Hi All, in ZOHO CRM when an enquiry stage is moved to WON then I have created a rule to trigger POST URL to thrid party AP and then create a function for mapping with below code void automation.kytesfunctions(String enquiryId) { // Fetch enquiry detailsSample Ticket - Created from Bot Preview
Why is Zoho desk adding bot created tickets?Webhook data is not being received
We’ve set up the webhook with a public URL that returns a 200 status on Postman. However, when we ran a test, we didn’t receive anything in the req.body object or see any data from the POST request. As a team of freshers still learning the ropes of development,Number of Workflow runs
Is there a way in Zoho desk to see statistics regarding workflows, rules and other automation objects? Would be nice for several reasons: You could ensure that your workflows are actually running. You could determine which ones weren't being used so youMail is no longer populating CRM contacts
Hi! For the last few days, my mail hasn't been populating my CRM contacts. Even people I email multiple times per day. In fact, it keeps trying to send mail to myself. Notice, I started typing Amy and only got as far as, "Am" and it suggested myself.Zoho Support is indeed shocking and difficult to get a response with
All our business emails have an auto-foward set up on them so that they also go to our GMAIL accounts so that we receive them to the relevenat people. The emails are indeed auto forwarding and arriving to our GMAIL accounts but when you log into yourHow to get a list of selected records into a button-function? Here is how!
So, you might know already how to get a button on a page somewhere and perform actions with a function when pressed, but how about a button that only works with the records you selected in the list view? The button selected is a custom button in the modulesHow to Add Break line / Return on button click
I need to return the text concate with difference field from lead with line break i try "\r" ,"\n" "<br>" return "ali \r\n <br> baba"; None of above work. i expected result something like this ali baba but got this ali \r\n <br> baba so, how can iNext Page