POST - Update Org Settings

​Purpose

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 much more using this API.

Request URL

https://calendar.zoho.com/api/v1/orgSettings

OAuth Scope

scope=ZohoCalendar.orgsettings.ALL

or

scope=ZohoCalendar.orgsettings.CREATE

​

ALL - Full access to org settings

CREATE - Updates org settings.

Request Parameters

  • modeint, mandatory
    • The mode denotes the type of operation (update) that you need to perform using this API.
    • Allowed value: mode=1
    • The value "1" for mode denotes that you want to update org settings.
  • orgSettingsDataJSONObject, mandatory
    • It is a mandatory OrgSettingsJson having other key parameters such as the max_dur, min_booking_dur, etc., Any of the key params given below can be added based on the requirement.
    • OrgSettingsJson:​
      • max_durint, optional
        • The max_dur parameter denotes the time after which the users cannot book a room/ resource.
        • For example, if the maximum duration is set to 3 months, the user cannot book a room for any time duration beyond 3 months.
        • Allowed values start from 3 to ​12.
      • min_booking_durint, optional
        • min_booking_dur denotes the time duration below which a resource cannot be booked.
        • For example, if the minimum booking duration is set for 30 minutes, then the users cannot book a room for less than 30 mins, say 20 mins.
        • Allowed values:
          • The minimum duration is set to 15 minutes by default.
          • The admin can provide the values in minutes (30, 1 hour, 1 hour 30 mins, and so on)
      • max_booking_durint, optional
        • max_booking_dur denotes the time duration beyond which a resource cannot be booked.
        • For example, if the maximum booking duration is set to 2 hours, then the users cannot book a room for 3 hours continuously.
        • Allowed values:
          • The maximum duration can be given in hours not exceeding the max_dur time.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/orgSettings?mode=1&orgSettingsData={"max_dur":7}

Sample Response

Copied{
"bk_confirm":false,
"max_dur":7,
"checkIn":false,
"bk_abandon_period":10,
"bk_confirm_period":30,
"rsvp_resource_release":false,
"max_booking_dur":2,
"bk_abandon_protect":false,
"min_booking_dur":120,
"resource_replacement":false,
"grid_view":"VIEW_DETAILS",
"rsvp_resource_release_period":30
}