deleteResource( )

Deletes a resource.

The deleteResource() function returns a Promise that resolves to the resource ID when the resouce 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.
  • Only users with the Bookings Admin role can delete a resource. You can override the role permissions by setting the options.suppressAuth parameter to true.

Notes:

  • The Bookings app creates a resource with "business" in name and tag values. 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.
Method Declaration
Copy
Method Parameters
resourceIdstringRequired

ID of the resource to delete.

optionsOptions

An object representing the available options for deleting a resource.

Returns
Return Type:Promise<string>
Did this help?