Zoho Calendar
App · Calendars · 17 actions
Online calendar. Create and manage calendars and events, share calendars, search events and check free/busy.
Actions
| Action | What it does |
|---|---|
| Create calendar | Create a personal calendar. |
| Create event | Add an event to a calendar: timed (start and end) or all-day (start and end date), optionally repeating, with attendees and a reminder. |
| Delete calendar | Delete a calendar and its events. |
| Delete event | Delete an event (every occurrence, for a repeating one), optionally emailing its attendees. |
| Get calendar | Get one calendar's name, colour, time zone and settings. |
| Get calendar sharing | List who a calendar is shared with, and their access. |
| Get event | Get one event with its description, attendees and reminders. |
| Get free/busy | See when someone in your Zoho organization (or you) is busy between two days. |
| Get settings | Get your Zoho Calendar settings: time zone, date and time format, working hours and week start. |
| List calendars | List your calendars with the uid each other action takes. |
| List events | List a calendar's events between two days, at most 31 days apart counting both. |
| List occurrences of a repeating event | List the occurrences of a repeating event between two days, at most 90 days apart counting both. |
| Move event | Move an event to another of your calendars. |
| Search events | Find a calendar's events whose title contains some text, between two days at most 90 days apart. |
| Share calendar | Share a calendar with someone by email, change their access, or stop sharing with them. |
| Update calendar | Rename a calendar or change its colour, description, time zone or visibility. |
| Update event | Change an event. |
Create calendar
Create a personal calendar.
Inputs
- Name
nametextRequired - The calendar's name, up to 50 characters.
- Colour
colortext - Optional. A hex colour such as #4986E7.
- Description
descriptiontext - Optional. Up to 1,000 characters.
- Time zone
timezonetext - Optional. An IANA time zone such as Europe/London. Leave blank for your Zoho Calendar time zone.
- Free/busy
include_in_free_busytext - Optional. Whether this calendar's events make you show as busy.One of:
include(Count as busy),exclude(Don't count as busy). - Public access
public_accesstext - Optional. What people without access can see of this calendar.One of:
disable(Nothing),freebusy(Free/busy only),view(Events). - Reminder (minutes before)
reminder_minutesnumber - Optional. Remind this many minutes before the start.From 0 to 40320.
- Reminder type
reminder_actiontext - Optional. How to remind (default pop-up).One of:
popup(Pop-up),email,notification.
Outputs
A Zoho Calendar calendar.
allowed_conferencetext- The conferencing services it allows.
caltypetext- Zoho's calendar type name.
categorytext- own, group, app or others.
colortext- The calendar's colour, for example #8cbf40.
createdtimetext- When it was created.
ctagnumber- Changes whenever the calendar's events change.
descriptiontext- The calendar's description.
idtext- Zoho's internal numeric id (not the one to pass to other actions).
include_infreebusytrue/false- Whether its events count towards free/busy.
isdefaulttrue/false- Whether it is the user's default calendar.
modifiedtimetext- When it was last changed.
nametext- The calendar's name.
ordernumber- Its position in the calendar list.
ownertext- The calendar's owner.
privilegetext- What the connected user may do with it, for example owner.
reminderslist- The default reminders for its events.
statustrue/false- Whether its events are shown.
textcolortext- The text colour of its events.
timezonetext- The calendar's time zone, for example Asia/Kolkata.
typenumber- Zoho's calendar type number.
uidtext- The calendar's uid: the id every other action takes.
visibilitytrue/false- Whether it is shown in the calendar list.
Example output
{
"category": "own",
"color": "#4986E7",
"description": "Team events",
"id": "1234567000000012345",
"include_infreebusy": true,
"isdefault": false,
"name": "Team",
"privilege": "owner",
"reminders": [
{
"action": "popup",
"minutes": "-15"
}
],
"status": true,
"textcolor": "#FFFFFF",
"timezone": "Europe/London",
"uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"visibility": true
}Create event
Add an event to a calendar: timed (start and end) or all-day (start and end date), optionally repeating, with attendees and a reminder.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Title
titletextRequired - The event's title.
- Start
startdate and time - When a timed event starts. For an all-day event, set Start date and End date instead.
- End
enddate and time - When a timed event ends.
- Start date (all day)
start_datedate - For an all-day event: its first day. Leave blank for a timed event.
- End date (all day)
end_datedate - For an all-day event: its last day.
- Time zone
timezonetext - Optional. An IANA time zone such as Europe/London. Leave blank for your Zoho Calendar time zone.
- Description
descriptiontext - Optional. Up to 10,000 characters.
- Location
locationtext - Optional. Up to 255 characters.
- Link
urltext - Optional. A link to attach to the event.
- Colour
colortext - Optional. A hex colour such as #4986E7.
- Privacy
privacytext - Optional. A private event hides its details from others.One of:
public,private. - Show as
show_astext - Optional. Whether the event makes you busy (default busy).One of:
busy,free. - Attendees
attendeeslist - Optional. Email addresses to invite.
- Attendee permission
attendee_permissiontext - Optional. What the attendees may do with the event.One of:
guest,view(View attendees),invite(Invite others),edit(Edit the event). - Reminder (minutes before)
reminder_minutesnumber - Optional. Remind this many minutes before the start.From 0 to 40320.
- Reminder type
reminder_actiontext - Optional. How to remind (default pop-up).One of:
popup(Pop-up),email,notification. - Repeat rule
rruletext - Optional. Makes the event repeat, as an iCalendar rule such as FREQ=WEEKLY;BYDAY=MO,WE;COUNT=10 (FREQ is DAILY, WEEKLY, MONTHLY or YEARLY).
- Email attendees
notify_attendeestext - Optional. Who Zoho emails about this change (default nobody).One of:
none(Nobody),attendees,attendees_and_me(Attendees and me).
Outputs
A Zoho Calendar event.
attendeeslist- The attendees.
calidtext- Zoho's internal id of that calendar.
caluidtext- The uid of the calendar it is in.
colortext- The event's colour.
createdbytext- Who created it.
createdtimetext- When it was created.
dateandtimeobject- The event's start and end.
descriptiontext- The event's description.
durationnumber- Its length in seconds.
endtext- The end in the user's time zone.
estatustext- Zoho's status for the change, for example added or updated.
etagtext- Its version; changes on every edit.
isalldaytrue/false- Whether it is an all-day event.
isprivatetrue/false- Whether it is private.
lastmodifiedtimetext- When it was last changed.
locationtext- The event's location.
modifiedbytext- Who last changed it.
multidaytrue/false- Whether it spans several days.
organizertext- The organizer's email address.
recurrenceidtext- Which occurrence this is, for one occurrence of a series.
reminderslist- The reminders.
rruletext- Its repeat rule, for a repeating event.
starttext- The start in the user's time zone, for example 20261031T100000.
titletext- The event's title.
transparencynumber- 0 shows as busy, 1 as free.
uidtext- The event's uid: the id every other event action takes.
urltext- A link attached to the event.
viewEventURLtext- A link to the event in Zoho Calendar.
Example output
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"estatus": "added",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}Delete calendar
Delete a calendar and its events. Your default calendar cannot be deleted.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
Outputs
The deleted calendar.
deletedtrue/false- True: Zoho reported the calendar deleted.
uidtext- The deleted calendar's uid.
Example output
{
"deleted": true,
"uid": "l9WWZCf_SJWcr3uIuBOq5g=="
}Delete event
Delete an event (every occurrence, for a repeating one), optionally emailing its attendees.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Event uid
event_uidtextRequired - The event's uid (ends in @zoho.com), from 'List events', 'Search events' or 'Create event'.
- Email attendees
notify_attendeestext - Optional. Who Zoho emails about this change (default nobody).One of:
none(Nobody),attendees,attendees_and_me(Attendees and me).
Outputs
The deleted event.
calendar_uidtext- The uid of the calendar it was in.
deletedtrue/false- True: Zoho reported the event deleted.
uidtext- The deleted event's uid.
Example output
{
"calendar_uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"deleted": true,
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}Get calendar
Get one calendar's name, colour, time zone and settings.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
Outputs
A Zoho Calendar calendar.
allowed_conferencetext- The conferencing services it allows.
caltypetext- Zoho's calendar type name.
categorytext- own, group, app or others.
colortext- The calendar's colour, for example #8cbf40.
createdtimetext- When it was created.
ctagnumber- Changes whenever the calendar's events change.
descriptiontext- The calendar's description.
idtext- Zoho's internal numeric id (not the one to pass to other actions).
include_infreebusytrue/false- Whether its events count towards free/busy.
isdefaulttrue/false- Whether it is the user's default calendar.
modifiedtimetext- When it was last changed.
nametext- The calendar's name.
ordernumber- Its position in the calendar list.
ownertext- The calendar's owner.
privilegetext- What the connected user may do with it, for example owner.
reminderslist- The default reminders for its events.
statustrue/false- Whether its events are shown.
textcolortext- The text colour of its events.
timezonetext- The calendar's time zone, for example Asia/Kolkata.
typenumber- Zoho's calendar type number.
uidtext- The calendar's uid: the id every other action takes.
visibilitytrue/false- Whether it is shown in the calendar list.
Example output
{
"category": "own",
"color": "#4986E7",
"description": "Team events",
"id": "1234567000000012345",
"include_infreebusy": true,
"isdefault": false,
"name": "Team",
"privilege": "owner",
"reminders": [
{
"action": "popup",
"minutes": "-15"
}
],
"status": true,
"textcolor": "#FFFFFF",
"timezone": "Europe/London",
"uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"visibility": true
}Get calendar sharing
List who a calendar is shared with, and their access.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
Outputs
Who a calendar is shared with.
calendar_uidtext- The calendar's uid.
countnumber- How many there are.
shareslist- The people and groups it is shared with.
Example output
{
"calendar_uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"count": 1,
"shares": [
{
"emailid": "bob@example.com",
"privilege": "view"
}
]
}Get event
Get one event with its description, attendees and reminders.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Event uid
event_uidtextRequired - The event's uid (ends in @zoho.com), from 'List events', 'Search events' or 'Create event'.
Outputs
A Zoho Calendar event.
attendeeslist- The attendees.
calidtext- Zoho's internal id of that calendar.
caluidtext- The uid of the calendar it is in.
colortext- The event's colour.
createdbytext- Who created it.
createdtimetext- When it was created.
dateandtimeobject- The event's start and end.
descriptiontext- The event's description.
durationnumber- Its length in seconds.
endtext- The end in the user's time zone.
estatustext- Zoho's status for the change, for example added or updated.
etagtext- Its version; changes on every edit.
isalldaytrue/false- Whether it is an all-day event.
isprivatetrue/false- Whether it is private.
lastmodifiedtimetext- When it was last changed.
locationtext- The event's location.
modifiedbytext- Who last changed it.
multidaytrue/false- Whether it spans several days.
organizertext- The organizer's email address.
recurrenceidtext- Which occurrence this is, for one occurrence of a series.
reminderslist- The reminders.
rruletext- Its repeat rule, for a repeating event.
starttext- The start in the user's time zone, for example 20261031T100000.
titletext- The event's title.
transparencynumber- 0 shows as busy, 1 as free.
uidtext- The event's uid: the id every other event action takes.
urltext- A link attached to the event.
viewEventURLtext- A link to the event in Zoho Calendar.
Example output
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}Get free/busy
See when someone in your Zoho organization (or you) is busy between two days.
Inputs
- Email
emailtextRequired - The Zoho user's email address.
- From
from_datedateRequired - The first day.
- To
to_datedateRequired - The last day.
- Breakdown
breakdowntext - Optional. How to report busy time (default busy periods).One of:
eventbased(Busy periods),timebased(Busy hours per day).
Outputs
When a user is busy.
busylist- The busy periods (the Busy periods breakdown).
countnumber- How many busy periods or days were returned.
dayslist- The days (the Busy hours per day breakdown).
emailtext- The user asked about.
Example output
{
"busy": [
{
"endTime": "20261031T110000Z",
"fbtype": "busy",
"startTime": "20261031T100000Z"
}
],
"count": 1,
"days": [],
"email": "ada@example.com"
}Get settings
Get your Zoho Calendar settings: time zone, date and time format, working hours and week start.
Inputs
None.
Outputs
The connected user's Zoho Calendar settings.
dateformattext- How dates are shown.
default_viewtext- The view Zoho Calendar opens on.
event_durationnumber- The default event length.
hourendnumber- When the working day ends.
hourstartnumber- When the working day starts.
timeformattext- 12 or 24 hour clock.
timezonetext- The user's time zone, for example Europe/London.
weekstartnumber- The first day of the week.
workweek_endnumber- The last working day.
workweek_startnumber- The first working day.
Example output
{
"dateformat": "dd/MM/yyyy",
"hourend": 17,
"hourstart": 9,
"timeformat": "24",
"timezone": "Europe/London",
"weekstart": 1
}List calendars
List your calendars with the uid each other action takes. By default only your own calendars; choose a category for group, app or shared ones.
Inputs
- Category
categorytext - Optional. Which calendars (default your own).One of:
own(My calendars),group(Group calendars),app(App calendars),others(Shared with me),all. - Include hidden calendars
include_hiddentrue/false - Optional. Also list calendars you have hidden.Default:
false.
Outputs
Calendars.
calendarslist- The calendars.
countnumber- How many calendars were returned.
Example output
{
"calendars": [
{
"category": "own",
"color": "#4986E7",
"description": "Team events",
"id": "1234567000000012345",
"include_infreebusy": true,
"isdefault": false,
"name": "Team",
"privilege": "owner",
"reminders": [
{
"action": "popup",
"minutes": "-15"
}
],
"status": true,
"textcolor": "#FFFFFF",
"timezone": "Europe/London",
"uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"visibility": true
}
],
"count": 1
}List events
List a calendar's events between two days, at most 31 days apart counting both.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- From
from_datedateRequired - The first day.
- To
to_datedateRequired - The last day.
- One row per occurrence
expand_recurringtrue/false - Optional. List each occurrence of a repeating event separately (Zoho then returns fewer details).Default:
false. - Time zone
timezonetext - Optional. An IANA time zone such as Europe/London. Leave blank for your Zoho Calendar time zone.
Outputs
Events.
countnumber- How many events were returned.
eventslist- The events.
Example output
{
"count": 1,
"events": [
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}
]
}List occurrences of a repeating event
List the occurrences of a repeating event between two days, at most 90 days apart counting both.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Event uid
event_uidtextRequired - The event's uid (ends in @zoho.com), from 'List events', 'Search events' or 'Create event'.
- From
from_datedateRequired - The first day.
- To
to_datedateRequired - The last day.
Outputs
Events.
countnumber- How many events were returned.
eventslist- The events.
Example output
{
"count": 1,
"events": [
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"recurrenceid": "20261031T100000Z",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}
]
}Move event
Move an event to another of your calendars. Works between personal and group calendars, not shared or app calendars.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Event uid
event_uidtextRequired - The event's uid (ends in @zoho.com), from 'List events', 'Search events' or 'Create event'.
- Move to calendar
destination_calendar_uidtextRequired - The calendar to move it to.
Outputs
A Zoho Calendar event.
attendeeslist- The attendees.
calidtext- Zoho's internal id of that calendar.
caluidtext- The uid of the calendar it is in.
colortext- The event's colour.
createdbytext- Who created it.
createdtimetext- When it was created.
dateandtimeobject- The event's start and end.
descriptiontext- The event's description.
durationnumber- Its length in seconds.
endtext- The end in the user's time zone.
estatustext- Zoho's status for the change, for example added or updated.
etagtext- Its version; changes on every edit.
isalldaytrue/false- Whether it is an all-day event.
isprivatetrue/false- Whether it is private.
lastmodifiedtimetext- When it was last changed.
locationtext- The event's location.
modifiedbytext- Who last changed it.
multidaytrue/false- Whether it spans several days.
organizertext- The organizer's email address.
recurrenceidtext- Which occurrence this is, for one occurrence of a series.
reminderslist- The reminders.
rruletext- Its repeat rule, for a repeating event.
starttext- The start in the user's time zone, for example 20261031T100000.
titletext- The event's title.
transparencynumber- 0 shows as busy, 1 as free.
uidtext- The event's uid: the id every other event action takes.
urltext- A link attached to the event.
viewEventURLtext- A link to the event in Zoho Calendar.
Example output
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "a3fe8c1b2d4e4f6a8b0c2d4e6f8a0b1c",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"estatus": "updated",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}Search events
Find a calendar's events whose title contains some text, between two days at most 90 days apart.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Title contains
search_texttextRequired - The text to look for in event titles.
- From
from_datedateRequired - The first day.
- To
to_datedateRequired - The last day.
Outputs
Events whose title matched.
countnumber- How many matched.
eventslist- The matching events.
Example output
{
"count": 1,
"events": [
{
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"isallday": false,
"timezone": "Europe/London",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}
]
}Share calendar
Share a calendar with someone by email, change their access, or stop sharing with them.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Email
emailtextRequired - The person's email address.
- Access
privilegetext - Optional. What they can see or do (default view).One of:
freebusy(Free/busy only),view(View events),moderate(Add and edit events),delegate(Manage on my behalf). - Change
modetext - Optional. Share, change access, or stop (default share).One of:
add(Share),edit(Change access),delete(Stop sharing).
Outputs
The sharing change.
calendar_uidtext- The calendar's uid.
emailtext- The email address the change was for.
messagetext- Zoho's confirmation, for example Updated Successfully.
modetext- add, edit or delete.
privilegetext- The access given, for add and edit.
statustext- success.
Example output
{
"calendar_uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"email": "bob@example.com",
"message": "Updated Successfully",
"mode": "add",
"privilege": "view",
"status": "success"
}Update calendar
Rename a calendar or change its colour, description, time zone or visibility. Only what you fill in is changed.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Name
nametext - Optional. A new name, up to 50 characters.
- Colour
colortext - Optional. A hex colour such as #4986E7.
- Description
descriptiontext - Optional. A new description.
- Time zone
timezonetext - Optional. An IANA time zone such as Europe/London. Leave blank for your Zoho Calendar time zone.
- Free/busy
include_in_free_busytext - Optional. Whether this calendar's events make you show as busy.One of:
include(Count as busy),exclude(Don't count as busy). - Public access
public_accesstext - Optional. What people without access can see of this calendar.One of:
disable(Nothing),freebusy(Free/busy only),view(Events).
Outputs
A Zoho Calendar calendar.
allowed_conferencetext- The conferencing services it allows.
caltypetext- Zoho's calendar type name.
categorytext- own, group, app or others.
colortext- The calendar's colour, for example #8cbf40.
createdtimetext- When it was created.
ctagnumber- Changes whenever the calendar's events change.
descriptiontext- The calendar's description.
idtext- Zoho's internal numeric id (not the one to pass to other actions).
include_infreebusytrue/false- Whether its events count towards free/busy.
isdefaulttrue/false- Whether it is the user's default calendar.
modifiedtimetext- When it was last changed.
nametext- The calendar's name.
ordernumber- Its position in the calendar list.
ownertext- The calendar's owner.
privilegetext- What the connected user may do with it, for example owner.
reminderslist- The default reminders for its events.
statustrue/false- Whether its events are shown.
textcolortext- The text colour of its events.
timezonetext- The calendar's time zone, for example Asia/Kolkata.
typenumber- Zoho's calendar type number.
uidtext- The calendar's uid: the id every other action takes.
visibilitytrue/false- Whether it is shown in the calendar list.
Example output
{
"category": "own",
"color": "#4986E7",
"description": "Team events",
"id": "1234567000000012345",
"include_infreebusy": true,
"isdefault": false,
"name": "Team",
"privilege": "owner",
"reminders": [
{
"action": "popup",
"minutes": "-15"
}
],
"status": true,
"textcolor": "#FFFFFF",
"timezone": "Europe/London",
"uid": "l9WWZCf_SJWcr3uIuBOq5g==",
"visibility": true
}Update event
Change an event. Only what you fill in is changed; for a repeating event the whole series changes.
Inputs
- Calendar
calendar_uidtextRequired - The calendar. Pick it from the list, or type its uid (from 'List calendars') or default for your default calendar.
- Event uid
event_uidtextRequired - The event's uid (ends in @zoho.com), from 'List events', 'Search events' or 'Create event'.
- Title
titletext - Optional. The event's title. Leave blank to keep the current one.
- Start
startdate and time - When a timed event starts. For an all-day event, set Start date and End date instead. Leave blank to keep the current one.
- End
enddate and time - When a timed event ends. Leave blank to keep the current one.
- Start date (all day)
start_datedate - For an all-day event: its first day. Leave blank for a timed event.
- End date (all day)
end_datedate - For an all-day event: its last day.
- Time zone
timezonetext - Optional. An IANA time zone such as Europe/London. Leave blank for your Zoho Calendar time zone.
- Description
descriptiontext - Optional. Up to 10,000 characters. Leave blank to keep the current one.
- Location
locationtext - Optional. Up to 255 characters. Leave blank to keep the current one.
- Link
urltext - Optional. A link to attach to the event. Leave blank to keep the current one.
- Colour
colortext - Optional. A hex colour such as #4986E7.
- Privacy
privacytext - Optional. A private event hides its details from others.One of:
public,private. - Show as
show_astext - Optional. Whether the event makes you busy (default busy).One of:
busy,free. - Attendees
attendeeslist - Optional. Email addresses to invite. Replaces the current attendees.
- Attendee permission
attendee_permissiontext - Optional. What the attendees may do with the event.One of:
guest,view(View attendees),invite(Invite others),edit(Edit the event). - Reminder (minutes before)
reminder_minutesnumber - Optional. Remind this many minutes before the start.From 0 to 40320.
- Reminder type
reminder_actiontext - Optional. How to remind (default pop-up).One of:
popup(Pop-up),email,notification. - Repeat rule
rruletext - Optional. Makes the event repeat, as an iCalendar rule such as FREQ=WEEKLY;BYDAY=MO,WE;COUNT=10 (FREQ is DAILY, WEEKLY, MONTHLY or YEARLY).
- Email attendees
notify_attendeestext - Optional. Who Zoho emails about this change (default nobody).One of:
none(Nobody),attendees,attendees_and_me(Attendees and me).
Outputs
A Zoho Calendar event.
attendeeslist- The attendees.
calidtext- Zoho's internal id of that calendar.
caluidtext- The uid of the calendar it is in.
colortext- The event's colour.
createdbytext- Who created it.
createdtimetext- When it was created.
dateandtimeobject- The event's start and end.
descriptiontext- The event's description.
durationnumber- Its length in seconds.
endtext- The end in the user's time zone.
estatustext- Zoho's status for the change, for example added or updated.
etagtext- Its version; changes on every edit.
isalldaytrue/false- Whether it is an all-day event.
isprivatetrue/false- Whether it is private.
lastmodifiedtimetext- When it was last changed.
locationtext- The event's location.
modifiedbytext- Who last changed it.
multidaytrue/false- Whether it spans several days.
organizertext- The organizer's email address.
recurrenceidtext- Which occurrence this is, for one occurrence of a series.
reminderslist- The reminders.
rruletext- Its repeat rule, for a repeating event.
starttext- The start in the user's time zone, for example 20261031T100000.
titletext- The event's title.
transparencynumber- 0 shows as busy, 1 as free.
uidtext- The event's uid: the id every other event action takes.
urltext- A link attached to the event.
viewEventURLtext- A link to the event in Zoho Calendar.
Example output
{
"attendees": [
{
"email": "bob@example.com",
"status": "NEEDS-ACTION"
}
],
"caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
"dateandtime": {
"end": "20261031T110000+0000",
"start": "20261031T100000+0000",
"timezone": "Europe/London"
},
"description": "Quarterly planning",
"end": "20261031T110000",
"estatus": "updated",
"etag": "1790000000000",
"isallday": false,
"isprivate": false,
"location": "Room 1",
"organizer": "ada@example.com",
"start": "20261031T100000",
"title": "Planning",
"uid": "8f1c2d3e4f5a46b7a8c9d0e1f2a3b4c5@zoho.com"
}