Skip to main content

Delete Workspace

 

Purpose

To delete a workspace

 

Request URL

https://www.zohoapis.com/bookings/v1/json/deleteworkspace

 

Headers

Parameter NameDescription
AuthorizationZoho-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 NameDescription
workspaceId*The unique id of the workspace to be deleted
ignorePastAppointmentAllowed values: true, false 
If true, workspace will be deleted even if past appointments are present. 
If false, workspace will not be deleted if past appointments are present. (when no value is passed, false will be the default)
Refer to the Points to Consider section to learn more.

Response Type

JSON

 

Points to consider


ignorePastAppointment

  • By default, if a workspace has past appointments, it cannot be deleted. If ignorePastAppointment is set to true, then the workspace can be deleted even if it has past appointments.

future appointments

  • The workspace cannot be deleted if it has a group service that has been booked. You can change the group service to another workspace, then try deleting the workspace.
  • If there are future appointments in a workspace, it cannot be deleted. You can either cancel those appointments or mark the workspace as inactive.

 

API Limits

Zoho Bookings Plan/EditionNumber of API calls/day
Free250/per user
Basic1000/per user
Premium3000/per user
Zoho One3000/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" : "133415000000890252",
"ignorePastAppointment" : true
}

Sample Response

Copied{
	response : {
		"returnvalue" : {
			"message" : "Workspace deleted successfully.",
			"status" : "success"
		},
		"status" : "success"
	}
}