Update Workspace
Table of Contents
Purpose
To update a workspace
Request URL
https://www.zohoapis.com/bookings/v1/json/updateworkspace
Headers
| Parameter Name | Description |
|---|---|
| Authorization | Zoho-oauthtoken {{accesstoken}} |
Note: The access token can be generated from the developer console.
Request Method
POST
Parameters
Parameters to be passed in the request body as form-data along with the request URL are,
| Parameter Name | Description |
|---|---|
| workspaceId* | The unique id of the workspace to be deleted |
| dataMap* | The map containing the details to be updated. Refer to the below parameters. |
| dataMap parameter details (Any one parameter is mandatory) | |
| name | Name of the workspace |
| status | Allowed values: active, in_active Set whether the workspace must be active or inactive. |
| description | Description of the workspace. It can be up to 2000 characters. |
| mail_notifications | Contains a map to configure the sender email for email notifications. Please refer to the sample request. |
| customer | Denotes sender email configurations for customer notifications |
| staff | Denotes sender email configurations for staff notifications |
| Denotes the sender email address. Allowed values: bookings, superadmin, staff, business, and workspace. | |
| replyto | Denotes the email address to which reply emails will be sent when the recipient replies. Allowed values: customer, superadmin, staff, business, and workspace. |
| CC | Denotes the email address that will be included as CC for email notifications. Allowed values: superadmin, staff, business, and workspace. |
| policies_and_preferences | Denotes a map to configure policies and preferences settings for the workspace. |
| scheduling_interval | Scheduling interval for the workspace. It must be a multiple of five, between 5 and 1435. |
| customer_select_staff | Specify whether the customer has to choose staff in the booking page. Allowed values: true, false |
| auto_assign_staff | Specify if the auto-assign staff option has to be included in the staff list. Allowed values: true, false |
| language | Give the preferred language for the workspace. Allowed values: userlanguage, en, fr, de, es, nl, pt, ar, ja, zh, he, it, ro, ru, sv, or sw. |
| prefix | Denotes the prefix of the booking ID. Length of the text can be 1 to 6. |
| maximum_invoice_digits | Length of the digits in the booking ID. Values must be between 1 to 16. |
| terms_and_conditions | Map containing details whether terms and conditions have to be included in the booking page. {"enable":"true","message":"terms and conditions"} Allowed values: 1. enable: true, false 2. message: provide the terms and conditions message. |
| minimum_booking_notice | Specify how much notice is required when an appointment is booked. The value is given in minutes as a multiple of 5. |
| maximum_booking_notice | Specify how far in advance an appointment can be booked. The value is given in minutes as a multiple of 5. |
| cancel_reschedule_notice | Specify before how much time an appointment is allowed to be rescheduled/cancelled. The value is given in minutes as a multiple of 5. |
| enable_cancel | Denotes whether rescheduling or cancelling is permitted for an appointment. Allowed values: true, false. |
Response Type
JSON
Points to consider
Name
- Special characters |/,?{}<>:;"'`\ are not allowed in workspace name
- The length of the workspace name must be between 2 - 50 characters.
General
- If only one workspace is present, then it cannot be marked as inactive.
Email notifications
- Business or workspace email: In the mail_notifications map, "business" and "workspace" values are also allowed if the respective mail is verified in Bookings.
- The value 'bookings' denote the default booking notification email, notification@zohobookings.com
API Limits
| Zoho Bookings Plan/Edition | Number of API calls/day |
| Free | 250/per user |
| Basic | 1000/per user |
| Premium | 3000/per user |
| Zoho One | 3000/per user |
Note: The API limits are excluding the authorization requests. API counts are calculated between 00:00 and 23:59 hours in the respective time zones.
Related Links
Sample Request
Copied{
"workspaceId" : "211427000000030018",
"dataMap" :
{
"name":"Consultations - New York",
"status":"active",
"description":"Description for New York workspace",
"mail_notifications":
{
"customer":
{
"email":"business",
"replyto":"superadmin",
"cc":"staff"
},
"staff":
{
"email":"bookings",
"replyto":"customer",
"cc":"staff"
}
},
"policies_and_preferences":
{
"scheduling_interval":10,
"customer_select_staff":"true",
"auto_assign_staff":"true",
"language":"userlanguage",
"prefix":"LA",
"maximum_invoice_digits":7,
"terms_and_conditions":
{
"enable":"true",
"message":"terms and conditions"
},
"minimum_booking_notice":30,
"maximum_booking_notice":30,
"cancel_reschedule_notice":30,
"enable_cancel":"true"
}
}
}Sample Response
Copied{
response : {
"returnvalue" : {
"message" : "Workspace updated successfully.",
"status" : "success"
},
"status" : "success"
}
}