This endpoint allows the partner to modify a seat map for events or classes. There are important rules that you must be aware of before using this endpoint:
-
All required fields are mandatory.
-
Spot Removal:
Removing a Spot from the seat map is a permanent action. When a Spot is deleted, the system will check whether any slots are associated with its position. If such slots exist, they will be automatically canceled.- Additionally, all existing links between the Spot and any scheduled events will be lost, and the value of externalReference will no longer be recoverable.
- Once a Spot is removed, it will disappear from the class booking interface within the app and cannot be reinstated through any automated process.
- This action is irreversible and should only be used when the Spot is permanently decommissioned or no longer relevant to the studio setup.
-
Non-Bookable Spots (All Category Spots Temporarily Unavailable):
If acategory
is set tobookable: false
, all spots within this category will become unavailable for booking. When a Category hasbookable: false
, the system will check whether any slots are associated with those spots. If such slots exist, they will be automatically canceled.- To make all spots available again, set the category to
bookable: true
. - This process does not impact the Spot’s
externalReference
or its associations with events, meaning no data is lost in the process.
- To make all spots available again, set the category to
-
Making a Non-Bookable Spot (Temporarily Unavailable):
If you simply want to prevent a specific Spot (or more) from being reserved without removing it from the seat map, you can make itnon-bookable
while keeping it visible to users in the app.- Create a new category in the seat map with the property
bookable
set tofalse
. - Move the desired Spot into that category.
Once this change is made, use the
Update a SeatMap
endpoint to apply it to the seat map.- To make the Spot available again, simply move it back to its original category and update the seat map once more.
- Unlike full removal, this process does not impact the Spot’s
externalReference
or its associations with events, meaning no data is lost in the process. - Due to the category being
bookable: false
, when adding new spots to this category to be temporarily deactivated, the system will check if any slots are associated with those spots. If they exist, the slots will be automatically canceled.
For example, if a bike is undergoing maintenance, it can be moved into a category like "Temporarily Unavailable Bikes" so that users can see the spot but won’t be able to book it.
Here is an example of how such a configuration might look:
{ "name": "Seatmap Exemple", "size": [6, 6], "categories": [ { "bookable": true, "name": "Bike", "icon": "bike", "positions": [ { "name": "Bike2", "externalReference": "B2", "position": [3, 3] } ] }, { "bookable": false, "name": "Temporarily Unavailable Bikes", "icon": "bike", "positions": [ { "name": "Bike1", "externalReference": "B1", "position": [3 ,2] } ] }, { "bookable": false, "name": "Air Conditioner", "icon": "ac", "positions": [ { "name": "AC", "externalReference": "C1", "position": [1, 5] } ] } ] }
- Create a new category in the seat map with the property