deleteResource( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a resource.
The deleteResource()
function returns a Promise that is resolved when a resource is deleted.
Deleting a resource updates its status to DELETED
.
You cannot delete a resource if it has booked sessions.
Notes:
- The Bookings app automatically creates a resource with a name and tag of value
"business"
. This resource is used for the business's schedule and working hours and cannot be deleted. - You can have up to 135 active resources and an additional 135 deleted resources.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Bookings
Manage Bookings - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired
ID of the resource to delete.
Returns
Return Type:Promise<DeleteResourceResponse>
Was this helpful?
Yes
No