POST - Add user settings

Purpose

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.

Request URL

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

OAuth Scope

scope=ZohoCalendar.usersettings.ALL

or

scope=ZohoCalendar.usersettings.CREATE

​

ALL - Full access to user settings

CREATE - Adds user settings.

Request Parameters

  • userSettingsDataJSONObject, mandatory
    • It is a mandatory UserSettingsJson having other key parameters such as the user id, branch id, and so on. Any of the key params given below can be updated based on the requirement.
    • UserSettingsJson:​
      • branch_idlong, optional
        • The branch ID can be fetched by using the Get Branch list API.
      • building_idlong, optional
        • The building ID can be fetched by using the Get Branch list/ Get Branch info API.
      • floor_idlong, optional
        • The floor ID can be fetched by using the Get Branch info API.
      • default_viewint, optional
        • The default view is the view of your resource booking grid that can be seen each time you log in or refresh your screen.
        • ​Allowed values:
          • default_view:0 denotes the Hour view of the resource booking grid.
          • default_view:1 denotes the Day view of the resource booking grid.
      • show_week_endsboolean, optional
        • The boolean value "true" will show weekends in the grid. The value "false" will hide the weekends from the grid.
      • any_timeboolean, optional
        • The boolean value "true" will show all 24 hours in the grid. The value "false" will show only the Work Hours.
  • zuidlong, optional
    • The zuid parameter can be given only by the org admin to add/ update a user setting.
  • modeint, mandatory
    • The mode denotes the type of operation that you need to perform using this API.
    • Allowed value: mode=0
    • The value "0" for mode denotes that you want to add a user setting.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/userSettings?userSettingsData={"branch_id":"1587118394609000002","building_id":"1587118394618000011","floor_id":"1587118394619000012"}&mode=0

Sample Response

Copied{
   "building_id":"1587118394618000011",
   "branch_id":"1587118394609000002",
   "floor_id":"1587118394619000012",
   "any_time":true,
   "default_view":0,
   "show_week_ends":true,
   "email":"cal1@m43.com",
   "zuid":"61130355"
}