POST - Add branch
Purpose
This API helps in adding a branch to resource booking. You can add the branch details such as the branch name, time zone, etc.,
Request URL
https://calendar.zoho.com/api/v1/branch
OAuth Scope
scope=ZohoCalendar.branches.ALL
or
scope=ZohoCalendar.branches.CREATE
ALL - Full access to all branches
CREATE - Adds a branch to resource booking
Request Parameters
- branchDataJSONObject, mandatory
- 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.
- BranchBuildingJson:
- branch_namestring, mandatory
- The branch name denotes the name of the different locations of your organization.
- work_start_hourstring, optional
- The start of your work timings. Denote it in 12 hours time format.
- Provide am and pm along with the time.
- Example: 05:00 am, 06:00 pm, 12:00 am, 12:00 pm.
- work_end_hourstring, optional
- The end of your work timings. Denote it in 12 hours time format.
- Provide am and pm along with the time.
- Example: 05:00 am, 06:00 pm, 12:00 am, 12:00 pm.
- work_start_dayint, optional
- 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_end_dayint, optional
- 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.
- time_zonestring, mandatory
- Mention the time zone in which the organization is located.
Sample Request
Copiedhttps://calendar.zoho.com/api/v1/branch?branchData: {"branch_name":"NewOne","work_start_day":"1","work_end_day":"5","time_zone":"Asia/Kolkata","work_start_hour":"10:00 am","work_end_hour":"07:00 pm","is_any_day":false}Sample Response
Copied{
"is_any_day": false,
"work_end_hour": "07:00 pm",
"branch_id": "1652855131249000001",
"branch_name": "NewOne",
"work_start_day": 1,
"work_start_hour": "10:00 am",
"time_zone": "Asia/Kolkata",
"work_end_day": 5
}