{"openapi":"3.0.0","info":{"description":"Calendar application","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Calendar application","url":"https://api.apirails.com/zohocalendar"}],"paths":{"/api/v1/branches":{"post":{"tags":["Branches"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/add-branch.html","api_endpoint":"https://{calendar_host}/api/v1/branches"},"summary":"Add branch","description":"This API helps in adding a branch to resource booking. You can add buildings and floors to each branch you add to resource booking. The buildings and floors can be given names and the floors can be listed using the floor order.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"blk_flr_info":{"type":"array","description":"The block floor info is a JSONArray containing the values of the **BuildingJson**.","required":true,"items":{"type":"object","properties":{}}},"branchData":{"type":"object","description":"`branchData` is a mandatory JSONObject that will have the values of branch name, work start and end hours, block floor info, and so on as **BranchBuildingJson**.","required":true,"properties":{}},"branch_name":{"type":"string","description":"The branch name denotes the name of the different locations of your organization.","required":true},"building_name":{"type":"string","description":"You can give names to the buildings that you add to resource booking.","required":true},"floor_count":{"type":"string","description":"The floor count is the number of floors that you have in a particular building that you add to resource booking. - You can use the integer values starting from 1.","required":true},"floor_name":{"type":"string","description":"Floor names can be given to the floors that are available in a building that you add in Resource Booking. - **Example:** Ground Floor, Floor - 1, Mezzanine, Terrace.","required":true},"floor_order":{"type":"string","description":"The floor order is the value that is assigned to each floor you add to a building. - The floors will be listed based on the number you give to each floor. - The floor with the floor order \"1\" will be listed at the top, followed by the floor orders of increasing integer values starting from 1.","required":true},"floors":{"type":"array","description":"The floors info is a JSONArray consisting of the values from the **FloorJson**.","required":true,"items":{"type":"object","properties":{}}},"time_zone":{"type":"string","description":"Mention the time zone in which the organization is located.","required":true},"work_end_day":{"type":"string","description":"It denotes the end day of your workweek. - The days are assigned with numbers from 0 to 6. (i.e.,) Sun - **0**, Mon - **1**, ..., Fri - **5**, Sat - **6**."},"work_end_hour":{"type":"string","description":"The end of your work timings. Denote it in 12 hours time format. - Provide **am** and **pm** along with the time. - Supported format: **hh:mm a** - **Example:** 05:00 am, 06:00 pm, 12:00 am, 12:00 pm."},"work_start_day":{"type":"string","description":"It denotes the start day of your workweek. - The days are assigned with numbers from 0 to 6. (i.e.,) Sun - **0**, Mon - **1**, ..., Fri - **5**, Sat - **6**."},"work_start_hour":{"type":"string","description":"The start of your work timings. Denote it in 12 hours time format. - Provide **am** and **pm** along with the time. - Supported format: **hh:mm a** - **Example:** 05:00 am, 06:00 pm, 12:00 am, 12:00 pm."}}},"example":{"blk_flr_info":[],"branchData":{},"branch_name":"","building_name":"","floor_count":"","floor_name":"","floor_order":"","floors":[],"time_zone":"","work_end_day":"","work_end_hour":"","work_start_day":"","work_start_hour":""}}}}},"get":{"tags":["Branches"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-branch-list.html","api_endpoint":"https://{calendar_host}/api/v1/branches"},"summary":"Get branch list","description":"This API is used to get the list of the branches available in an organization in Resource Booking. The data fetched using this API can be used to update, or delete a branch, or to fetch the details of a particular branch.","security":[{"bearerAuth":[]}]}},"/api/v1/features":{"post":{"tags":["Features"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/add-feature.html","api_endpoint":"https://{calendar_host}/api/v1/features"},"summary":"Add feature","description":"This API helps in adding a new feature to resource booking. The features are the types of available resources like chairs, projectors, etc., that are available inside a room.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"featureData":{"type":"object","description":"This is a mandatory **FeatureJson** that has the values of the key parameters such as feature name, its type, and whether it is shown/hidden.","required":true,"properties":{}},"feature_name":{"type":"string","description":"The feature name is the name of the available features in a room. - **Example:** Chairs, Projectors, Monitors, etc.","required":true},"feature_type":{"type":"string","description":"The feature type is given based on the feature's nature of availability. - **Allowed values:** - **0 - Availability** – The admin can choose **Yes/No** based on availability while adding the feature to a room in a branch. - **1 - Count** (Monitor - 4, Projector - 2) - **2 - String** (Contact Person ","required":true},"is_hidden":{"type":"boolean","description":"The boolean value for the feature will be **false** if the feature is visible to add to a room. If the value is **true**, the feature will not be available while adding features to a room.","enum":[true,false]}}},"example":{"featureData":{},"feature_name":"","feature_type":"","is_hidden":""}}}}},"get":{"tags":["Features"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-all-features.html","api_endpoint":"https://{calendar_host}/api/v1/features"},"summary":"Get all features","description":"This API retrieves the details of all the features in resource booking. The details that can be fetched using this API are feature IDs and names, their types, and whether they are shown/hidden.","security":[{"bearerAuth":[]}]}},"/api/v1/orgSettings":{"post":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/add-org-settings.html","api_endpoint":"https://{calendar_host}/api/v1/orgSettings"},"summary":"Add Org Settings","description":"This API helps in adding org settings. The org admin can set the maximum time period for a booking to be done, minimum and maximum booking durations, and more using this API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-org-settings.html","api_endpoint":"https://{calendar_host}/api/v1/orgSettings"},"summary":"Get Org Settings","description":"This API helps in fetching org settings.","security":[{"bearerAuth":[]}]}},"/api/v1/resources":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/add-resource.html","api_endpoint":"https://{calendar_host}/api/v1/resources"},"summary":"Add resource","description":"This API helps in adding a new resource. As for now, API support is given only for the addition of rooms to Resource Booking. The support for the addition of other resources will be available soon.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"string","description":"The rooms are classified into: - **0** for Meeting Room - **1** for Conference Room - **2** for Training Room - **3** for Other type of rooms"},"branch_id":{"type":"number","description":"The branch ID to which the resource should be added can be fetched by using the Get Branch list API.","required":true},"building_id":{"type":"number","description":"The building ID to which the resources should be added can be fetched by using the Get Branch list / Get Branch info API.","required":true},"capacity":{"type":"string","description":"The room's capacity can be given in numbers. - As we have enabled only the addition of rooms to resources, the room's capacity to hold the number of people should be given while adding it to resource booking."},"description":{"type":"string","description":"A description of the resource can be given."},"features":{"type":"array","description":"The **ResFeatureJson** consists of the feature id and feature value. This parameter can be used if you want to map features to the resources you add to a branch. The key parameters within the JSON are mandatory when you map a feature.","items":{"type":"object","properties":{}}},"floor_id":{"type":"number","description":"The floor ID to which the resource should be added can be fetched by using the Get Branch info API.","required":true},"image_name":{"type":"string","description":"The name for the image added should be given here."},"photo":{"type":"string","description":"The image file of the resource can be attached while adding a resource to resource booking. - The supported formats of image are **.png**, **.jpg**, **.jpeg**. - Maximum size - **10 MB**."},"resourceData":{"type":"object","description":"The `resourceData` has the values of key parameters like resource name, its type, category, etc., as **ResourceJson**.","required":true,"properties":{}},"resource_name":{"type":"string","description":"The resource name (room name) should be mentioned while adding it. - **Example:** Conference Hall, Testing room.","required":true},"resource_type":{"type":"string","description":"**Allowed values:** - **0** for Rooms - **1** and **2** for other resources (Support not provided at present)","required":true}}},"example":{"category":"","branch_id":"","building_id":"","capacity":"","description":"","features":[],"floor_id":"","image_name":"","photo":"","resourceData":{},"resource_name":"","resource_type":""}}}}},"get":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-all-resources.html","api_endpoint":"https://{calendar_host}/api/v1/resources"},"summary":"Get all resources","description":"This API retrieves the details of all the resources available in resource booking. To pick the resources you should provide either the branch id, building id, or floor id. You can also provide all three IDs. The IDs can be fetched using the GET branch API.","security":[{"bearerAuth":[]}]}},"/api/v1/userSettings":{"post":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/add-user-settings.html","api_endpoint":"https://{calendar_host}/api/v1/userSettings"},"summary":"Add user settings","description":"This API helps in adding user settings. The users can choose their default location, the default view for their resource booking grid, and choose to have only weekdays and work hours in their resource booking grid.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"mode":{"type":"string","description":"The mode denotes the type of operation that you need to perform using this API. - Allowed value: `mode=1` - The value `1` for mode denotes that you want to update a user setting.","required":true},"userSettingsData":{"type":"object","description":"It is mandatory to provide `UserSettingsJson` with other key parameters such as the user id, branch id, etc. Any of the key parameters given below can be updated based on the requirement.","required":true,"properties":{}},"zuid":{"type":"number","description":"The `zuid` parameter can be given only by the org admin to add/update a user setting."}}},"example":{"mode":"","userSettingsData":{},"zuid":""}}}}},"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-user-settings.html","api_endpoint":"https://{calendar_host}/api/v1/userSettings"},"summary":"Get user settings","description":"This API is used to fetch a particular user's settings in Resource Booking by users and admin. The Org Admin can fetch the details of other users using this API.","security":[{"bearerAuth":[]}]}},"/api/v1/attachment":{"post":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/attach-file.html","api_endpoint":"https://{calendar_host}/api/v1/attachment"},"summary":"Attach file","description":"This API is used to attach a file to an event in the calendar.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/bookings":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/book-resource.html","api_endpoint":"https://{calendar_host}/api/v1/bookings"},"summary":"Book a resource","description":"This API helps in booking a resource. As of now, **Room** booking alone is supported in Resource Booking.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attendees":{"type":"array","description":"The RBAttendeeJson will have the values of the email id of the attendees, their user id, and the type of permission given to them as a JSONArray.","items":{"type":"object","properties":{}}},"bookingData":{"type":"object","description":"This is a mandatory JSON that has the key parameters like title, attendees, date and time, and so on as listed as **BookingJson**.","required":true,"properties":{}},"dateandtime":{"type":"object","description":"The **DateandtimeJSON** has the values of the starting and ending time and date along with the time zone.","required":true,"properties":{}},"description":{"type":"string","description":"A description can be given for each booking you create."},"group_attendees":{"type":"array","description":"The group attendees JSON will have the values of group id and the type of permission given.","items":{"type":"object","properties":{}}},"isprivate":{"type":"boolean","description":"If the boolean value is **\"true\"** then the booking is private and will be shown as a private booking to other users. - If the value is **\"false\"** then the booking will be visible to all users.","enum":[true,false]},"notify_attendee":{"type":"string","description":"The notify attendee parameter is given to send notifications to the attendees added to a booking. The values for the parameter can be given as follows: - `notify_attendee=0` - Send notification to None. - `notify_attendee=1` - Send notification to all attendees excluding me. - `notify_attendee=2` - "},"repeat":{"type":"object","description":"The repeat JSON can be given if you want to add a recurring booking. The parameters marked mandatory should be given only when you add the **RepeatJson** to your request URL.","properties":{}},"resources":{"type":"array","description":"The resources JSONArray is required to book a resource. The key parameter values are provided as BookResJson.","required":true,"items":{"type":"object","properties":{}}},"title":{"type":"string","description":"A title should be given to each booking you make in Resource Booking.","required":true}}},"example":{"attendees":[],"bookingData":{},"dateandtime":{},"description":"","group_attendees":[],"isprivate":"","notify_attendee":"","repeat":{},"resources":[],"title":""}}}}}},"/api/v1/calendars/{calendar_uid}/events/{event_uid}":{"put":{"tags":["Attachments"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/put-update-event.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}"},"summary":"Update an Event","description":"This API is used to update the details of an existing event in a user's calendar. The update operation replaces the entire event resource, overwriting all existing fields with the values provided in the request. The same PUT with an eventdata body that drops an attachment also serves as the documented Delete Attachment op.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-event.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}"},"summary":"Delete event","description":"This API is used to delete an event from a user's calendar.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-event-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}"},"summary":"Get event details","description":"This API is used to get the event details of a specific event in the user's calendar.","security":[{"bearerAuth":[]}]},"post":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/move-event.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}"},"summary":"Move event","description":"This API is used to move event from one calendar to other.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/patch-partial-update-event.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}"},"summary":"Partial Update of an Event","description":"This API is used to edit only specific fields in an event. It partially updates the details of an existing event in a user’s calendar. The fields you include in the request will overwrite the event’s current values, while any fields not provided will remain unchanged.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/bookings/{booking_id}":{"delete":{"tags":["Bookings"],"parameters":[{"name":"booking_id","in":"path","description":"booking id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-booking.html","api_endpoint":"https://{calendar_host}/api/v1/bookings/{booking_id}"},"summary":"Delete booking","description":"This API is used to delete a booking.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Bookings"],"parameters":[{"name":"booking_id","in":"path","description":"booking id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-booking-info.html","api_endpoint":"https://{calendar_host}/api/v1/bookings/{booking_id}"},"summary":"Get booking info","description":"This API retrieves the details of a particular booking in Resource Booking.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bookings"],"parameters":[{"name":"booking_id","in":"path","description":"booking id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/update-booking.html","api_endpoint":"https://{calendar_host}/api/v1/bookings/{booking_id}"},"summary":"Update booking","description":"This API helps you to update a booking in resource booking.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/branches/{branchid}":{"delete":{"tags":["Branches"],"parameters":[{"name":"branchid","in":"path","description":"branchid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-branch.html","api_endpoint":"https://{calendar_host}/api/v1/branches/{branchid}"},"summary":"Delete branch","description":"This API is used to delete a branch from resource booking. You can fetch the branch ID of the branch you want to delete using the GET - Branch List API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Branches"],"parameters":[{"name":"branchid","in":"path","description":"branchid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-branch-info.html","api_endpoint":"https://{calendar_host}/api/v1/branches/{branchid}"},"summary":"Get branch info","description":"This API retrieves the details of a particular branch added to resource booking. The branch ID used in the Request URL given below can be fetched using the GET - Branch List API.","security":[{"bearerAuth":[]}]},"post":{"tags":["Branches"],"parameters":[{"name":"branchid","in":"path","description":"branchid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/update-branch.html","api_endpoint":"https://{calendar_host}/api/v1/branches/{branchid}"},"summary":"Update branch with building and floors","description":"This API is used to update the details of existing branch info in Resource Booking. You can update the branch name, building, and floor information using the API given below.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/calendars/{calendar_uid}":{"delete":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-calendar.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}"},"summary":"Delete calendar","description":"This API is used to delete a calendar using the calendar identifier.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/put-update-calendar.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}"},"summary":"Update calendar","description":"This API is used to update an existing calendar.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/features/{featureid}":{"delete":{"tags":["Features"],"parameters":[{"name":"featureid","in":"path","description":"featureid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-feature.html","api_endpoint":"https://{calendar_host}/api/v1/features/{featureid}"},"summary":"Delete feature","description":"This API is used to delete a feature from resource booking. The feature ID in the Request URL given below can be fetched using the Get all features API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Features"],"parameters":[{"name":"featureid","in":"path","description":"featureid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-feature-info.html","api_endpoint":"https://{calendar_host}/api/v1/features/{featureid}"},"summary":"Get feature info","description":"This API retrieves the details of a particular feature in resource booking. The feature ID in the Request URL can be fetched using the Get all features API.","security":[{"bearerAuth":[]}]},"post":{"tags":["Features"],"parameters":[{"name":"featureid","in":"path","description":"featureid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/update-feature.html","api_endpoint":"https://{calendar_host}/api/v1/features/{featureid}"},"summary":"Update feature","description":"This API helps in updating a feature in resource booking. You can add or remove the numbers of a particular feature or multiple features using this API. The feature ID in the Request URL given below can be fetched using the GET all features API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/resources/{resourceid}":{"delete":{"tags":["Resources"],"parameters":[{"name":"resourceid","in":"path","description":"resourceid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/delete-resource.html","api_endpoint":"https://{calendar_host}/api/v1/resources/{resourceid}"},"summary":"Delete resource","description":"This API is used to delete a resource from resource booking. The `resourceId` given in the Request URL can be fetched using the Get all resources API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Resources"],"parameters":[{"name":"resourceid","in":"path","description":"resourceid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-resource-info.html","api_endpoint":"https://{calendar_host}/api/v1/resources/{resourceid}"},"summary":"Get resource info","description":"This API retrieves the details of a particular resource in resource booking. The resource ID in the Request URL can be fetched using the Get all resources API.","security":[{"bearerAuth":[]}]},"post":{"tags":["Resources"],"parameters":[{"name":"resourceid","in":"path","description":"resourceid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/update-resource.html","api_endpoint":"https://{calendar_host}/api/v1/resources/{resourceid}"},"summary":"Update resource","description":"This API helps in updating a resource added to resource booking. The `resourceId` in the Request URL given below can be fetched using the Get all resources API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/organization/activity":{"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-activity-logs.html","api_endpoint":"https://{calendar_host}/api/v1/organization/activity"},"summary":"Activity logs","description":"This API is used to get the activity logs of the user. (This is accessible for admin users only).","security":[{"bearerAuth":[]}]}},"/api/v1/users":{"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-all-user-settings.html","api_endpoint":"https://{calendar_host}/api/v1/users"},"summary":"Get all user settings","description":"This API fetches all the users' settings available in Resource Booking. This API can be used only by the organization admin.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/{cal_uid}/events/{event_uid}/attachment/{file_id}":{"get":{"tags":["Attachments"],"parameters":[{"name":"cal_uid","in":"path","description":"cal uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"calendaruid","in":"path","description":"Calendar Unique Identifier. The calendar UID of the calendar from which the specific event should be fetched. - The Calendar UID can be retrieved from **Get calendar details API**.","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"eventuid","in":"path","description":"Event Unique Identifier. The event UID of the event, needs to be fetched. - The event UID can be retrieved from **Get event details API**.","required":true,"schema":{"type":"string","example":""}},{"name":"file_id","in":"path","description":"file id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-attachment-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{cal_uid}/events/{event_uid}/attachment/{file_id}"},"summary":"Get attachment details","description":"This API is used to get the details of a specific attachment in a particular event.","security":[{"bearerAuth":[]}]}},"/api/v1/bookings/list":{"get":{"tags":["Bookings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-booking-list.html","api_endpoint":"https://{calendar_host}/api/v1/bookings/list"},"summary":"Get bookings list","description":"This API is used to retrieve a list of all the bookings.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/{calendar_uid}|{default}|{primary}":{"get":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"default","in":"path","description":"default (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"primary","in":"path","description":"primary (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-calendar-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}|{default}|{primary}"},"summary":"Get calendar details","description":"This API retrieves the details of a particular calendar using the Calendar UID.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars":{"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-calendar-list.html","api_endpoint":"https://{calendar_host}/api/v1/calendars"},"summary":"Get calendar list","description":"This API is used to get the list of all calendars or list of calendars based on a specific category/entity of a given user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/post-create-calendar.html","api_endpoint":"https://{calendar_host}/api/v1/calendars"},"summary":"Create a New Calendar","description":"This API is used to create a new personal calendar.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/settings":{"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-calendar-settings.html","api_endpoint":"https://{calendar_host}/api/v1/settings"},"summary":"Get calendar settings","description":"This API is used to get the calendar settings of the user.","security":[{"bearerAuth":[]}]},"put":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/put-update-calendar-settings.html","api_endpoint":"https://{calendar_host}/api/v1/settings"},"summary":"Update calendar settings","description":"This API is used to update the calendar settings of the user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/calendars/{calendar_uid}/events/{event_uid}/byinstance":{"get":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-event-by-instance.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}/byinstance"},"summary":"Get Event By Instance","description":"This API is used to get all instances of a particular repeat event.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/{calendar_uid}/search":{"get":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-event-through-search.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/search"},"summary":"Get event through search","description":"This API is used to get a particular event from a calendar through search.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/{calendar_uid}/events":{"get":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-events-list.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events"},"summary":"Get events list","description":"This API is used to get a list of all the events in a particular calendar of the user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Events"],"parameters":[{"name":"calendar_uid","in":"path","description":"This parameter represents the unique identifier for the calendar in which a new event is created.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/post-create-event.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events"},"summary":"Create a New Event","description":"This API is used to create a new event in a user's calendar.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowForwarding":{"type":"boolean","description":"Specifies whether the attendees are allowed to forward the event or not. Allowed values: `true | false` - `true` - The attendees are allowed to forward the event. - `false` - The attendees are not allowed to forward the event.","enum":[true,false]},"attach":{"type":"object","description":"This parameter allows files to be attached to an event by including their unique file IDs in a comma-separated format. - **fileId** (string) Specifies the file(s) to be attached to the event. Multiple file IDs should be separated by commas. The file IDs correspond to files previously uploaded and re","properties":{}},"attendees":{"type":"array","description":"This parameter is used to include the attendee details for the event. - Example: ``` \"attendees\": [ {\"email\":\"user1@domain.com\", \"permission\":\"1\"}, {\"email\":\"user2@domain.com\",\"permission\":\"1\"} ] ``` Each object in the array includes: - **email** (string, mandatory) Specifies the email id of the att","items":{"type":"object","properties":{}}},"calendar_alarm":{"type":"boolean","description":"Specifies whether to enable a calendar alarm for the event. Allowed values: `true | false` - `true` - Enables a calendar alarm for the event. - `false` - Disables the calendar alarm.","enum":[true,false]},"color":{"type":"string","description":"Specifies the hex-color for the event. Use this to set a specific color for the event that differs from the default color. Example: `#E574B0`"},"conference":{"type":"string","description":"Specifies the conference option to associate with the event. Allowed values: `zmeeting | none`"},"dateandtime":{"type":"object","description":"Send JSON Object of the start time, end time in Unix time format along with the time zone information, in case different from the current user time zone. - **start** (string, mandatory) Specifies the start date and time of the event. Use the following formats: - For a specific time: `yyyyMMdd'T'HHmm","required":true,"properties":{}},"description":{"type":"string","description":"Specifies the description of the event, to provide more details about the event to the attendees. Maximum length: 10000 characters."},"eventdata":{"type":"object","description":"This JSON object is passed to define or update the data of a particular event in the calendar using the following keys and values.","required":true,"properties":{}},"group_attendees":{"type":"array","description":"This parameter is used if a group is added as attendee. - Example: ``` \"group_attendees\":[{\"zid\":\"1234567890\"}] ``` Each object includes: - **zid** (long, mandatory) Specifies the zuid of the group.","items":{"type":"object","properties":{}}},"isallday":{"type":"boolean","description":"Specifies whether the event is an all-day event or not. Allowed values: `true | false` - `true` - If true, use all-day event format in **dateandtime** JSON object. - `false`","enum":[true,false]},"isprivate":{"type":"boolean","description":"Specifies whether the event is private or not. Allowed values: `true | false` - `true` - When true, the event details are hidden from others, even if the calendar is public or shared, except for users with delegate permissions. - `false` - The event is public.","enum":[true,false]},"location":{"type":"string","description":"Specifies the location details for the event. Maximum length: 255 characters."},"notifyType":{"type":"number","description":"Specifies the notification type for the event. Currently, only the default notification type is supported. Allowed values: `1` - `1` - Default Notification"},"notify_attendee":{"type":"number","description":"Used to notify the attendees of the event. Allowed values: `0 | 1 | 2` - `0` - None. - `1` - Notify attendees only. - `2` - Notify both attendees and myself."},"reminders":{"type":"array","description":"Specifies the type of reminders to be set for the event. - Example: ``` \"reminders\":[ {\"action\": \"email\", \"minutes\": 30}, {\"action\": \"popup\", \"minutes\": 15} ] ``` Each object includes: - **action** (string) Specifies the reminder type. Allowed values: `email | popup | notification` - **minutes** (in","items":{"type":"object","properties":{}}},"repeat":{"type":"string","description":"Use either **rrule** or **repeat** parameter to create recurring/repeat events. Each object includes: - **freq** (string) Allowed values: `DAILY | WEEKLY | MONTHLY | YEARLY` - **interval** (integer) - **count** (integer) - **byday** (string) - **until** (string) - **bymonthday** (integer) - **bymont"},"richtext_description":{"type":"string","description":"This parameter is used to provide a rich-text formatted description for the event. If the description includes formatting (e.g., bold, italic, links), it should be provided in `richtext_description`. Maximum length: 12000 characters. **Note:** Either **description** or **richtext_description** shoul"},"rrule":{"type":"string","description":"This parameter is used to create repeat/recurring events. Allowed values: - **FREQ** (string) Specifies the frequency of the recurrence. Allowed values: `DAILY | WEEKLY | MONTHLY | YEARLY` - **INTERVAL** (integer) Specifies the interval between each occurrence. - `INTERVAL = 1` - Event occurs every "},"title":{"type":"string","description":"Specifies the title of the event to be added."},"transparency":{"type":"number","description":"Specifies whether the event should be added to the free/busy schedule. Allowed values: `0 | 1` - `0` - Add to free/busy schedule. - `1` - Don't add to your free/busy schedule. The grid will be shown as free even if events are present at that time."},"url":{"type":"string","description":"Specifies the URL details that need to be shared for the event, along with the description, if any. Example: `\"https://mail.zoho.com\"`"}}},"example":{"allowForwarding":"","attach":{},"attendees":[],"calendar_alarm":"","color":"","conference":"","dateandtime":{},"description":"","eventdata":{},"group_attendees":[],"isallday":"","isprivate":"","location":"","notifyType":"","notify_attendee":"","reminders":[],"repeat":"","richtext_description":"","rrule":"","title":"","transparency":"","url":""}}}}}},"/api/v1/resources/favorite":{"get":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-favorite-resources.html","api_endpoint":"https://{calendar_host}/api/v1/resources/favorite"},"summary":"Get favorite resources","description":"This API fetches all the resources marked as favorite.","security":[{"bearerAuth":[]}]},"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/mark-resource-as-favorite.html","api_endpoint":"https://{calendar_host}/api/v1/resources/favorite"},"summary":"Mark resource as favorite","description":"This API helps in marking a resource as a favorite. The marked resource will be listed under the favorite section of your resource booking grid. The `resourceId` of the resource that needs to be marked as favorite can be fetched using the Get all resources API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/calendars/{calendar_uid}/events/{event_uid}/groupattendeestatus":{"get":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}},{"name":"event_uid","in":"path","description":"event uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-group-attendees-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/events/{event_uid}/groupattendeestatus"},"summary":"Get group attendees details","description":"This API is used to get the group attendees details of a specific event in the user's calendar.","security":[{"bearerAuth":[]}]}},"/api/v1/groups":{"get":{"tags":["Calendars"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-group-calendar-list.html","api_endpoint":"https://{calendar_host}/api/v1/groups"},"summary":"Get Group Calendar list","description":"To get the list of all group calendars.","security":[{"bearerAuth":[]}]}},"/api/v1/notification":{"get":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-notification-details.html","api_endpoint":"https://{calendar_host}/api/v1/notification"},"summary":"Get notification details","description":"This API is used to get the notification details of a particular user.","security":[{"bearerAuth":[]}]},"put":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/put-update-notification-details.html","api_endpoint":"https://{calendar_host}/api/v1/notification"},"summary":"Update notification details","description":"This API is used to update the notification details of a particular user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/resources/freebusy":{"get":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-resource-availability.html","api_endpoint":"https://{calendar_host}/api/v1/resources/freebusy"},"summary":"Availability Status of Resources Based on Branch","description":"This API retrieves the availability of a particular resource based on the branch.","security":[{"bearerAuth":[]}]}},"/api/v1/rbaccess":{"get":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-resource-booking-access-detail.html","api_endpoint":"https://{calendar_host}/api/v1/rbaccess"},"summary":"Get Resource Booking Access Detail","description":"Before accessing the branches, the user should have access to Resource Booking.","security":[{"bearerAuth":[]}]}},"/api/v1/resources/{resourceuid}/freebusy":{"get":{"tags":["Resources"],"parameters":[{"name":"resourceuid","in":"path","description":"resourceuid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-resource-free-busy-detail.html","api_endpoint":"https://{calendar_host}/api/v1/resources/{resourceuid}/freebusy"},"summary":"Get resource free busy detail","description":"This API retrieves the free/ busy detail of a particular resource. The free/ busy detail of the resource denotes the availability of the resource to book at a particular period of time.","security":[{"bearerAuth":[]}]}},"/api/v1/images/{imageid}":{"get":{"tags":["Resources"],"parameters":[{"name":"imageid","in":"path","description":"imageid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-resource-image.html","api_endpoint":"https://{calendar_host}/api/v1/images/{imageid}"},"summary":"Get resource image","description":"This API fetches the image of a resource.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/{calendar_uid}/share":{"get":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-shared-calendar-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/share"},"summary":"Get shared calendar details","description":"This API is used to get the calendar details of a calendar that has been shared with another user.","security":[{"bearerAuth":[]}]},"put":{"tags":["Calendars"],"parameters":[{"name":"calendar_uid","in":"path","description":"calendar uid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/put-share-calendar.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/{calendar_uid}/share"},"summary":"Share calendar","description":"This API is used to update the calendar that is shared with another user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/bookings/mybookings":{"get":{"tags":["Bookings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-user-booking-detail.html","api_endpoint":"https://{calendar_host}/api/v1/bookings/mybookings"},"summary":"Get user booking detail","description":"This API retrieves a user's booking detail. The user can use this API to fetch details of all the bookings done by him/ her.","security":[{"bearerAuth":[]}]}},"/api/v1/calendars/freebusy":{"get":{"tags":["Free Busy"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/get-user-freebusy-details.html","api_endpoint":"https://{calendar_host}/api/v1/calendars/freebusy"},"summary":"Get user's free/ busy details","description":"This API is used to get the free/busy details of the user from all the calendars.","security":[{"bearerAuth":[]}]}},"/api/v1/smartadd":{"post":{"tags":["Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/post-create-event-smart-add.html","api_endpoint":"https://{calendar_host}/api/v1/smartadd"},"summary":"Create event using Smart Add","description":"This API is used to create a new event in a particular calendar using Smart Add.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v1/resources/favorite/{resourceid}":{"delete":{"tags":["Resources"],"parameters":[{"name":"resourceid","in":"path","description":"resourceid (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/calendar/help/api/remove-resource-from-favorites.html","api_endpoint":"https://{calendar_host}/api/v1/resources/favorite/{resourceid}"},"summary":"Remove a resource from favorites","description":"This API is used to remove/unmark a resource that has been marked as a favorite. The `resourceId` of the resource which should be removed from favorites can be fetched using the GET all resource API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}