AutomationTiles
Create AutomationTile
Create a new AutomationTile record.
POST
Create AutomationTile
An automation tile is a physical NFC or QR-code tile at a location that runs a configured action when a customer scans it, optionally restricting use by bookings, plans, passes, desks or offices, and geofencing.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the AutomationTile-Create role.Enums
eAutomationTileAction — Action values
eAutomationTileAction — Action values
eAutomationTileGeofencePrecission — GeofencePrecission values
eAutomationTileGeofencePrecission — GeofencePrecission values
Request Body
Required Fields
integer
required
ID of the location that owns this automation tile..
string
required
Name shown to customers when they scan the tile..
integer
required
Action performed when a customer scans the tile: None disables it; values also support check-in/out, booking and event actions, resource cleaning, HTTPS requests or redirects, and configured access-control or locker systems..
integer
required
Geofence precision setting: Low, Medium, High, or VeryHigh; use with the tile coordinates when EnableGeofence is enabled..
Optional Fields
string
Action-specific value: use a resource or desk ID, optionally followed by | and booking duration in minutes; a resource ID optionally followed by | and desk ID for booking check-in or the booking form; minutes for ExtendBookingBy; or the relevant door, locker, or URL ID. RequestUrl must start with https..
boolean
Whether tile use is restricted to the geographic area configured by its coordinates and radius or precision..
boolean
Whether to check the customer in at the tile’s location before running a non-CheckIn or non-CheckOut action..
string
Longitude coordinate of the tile for geographic restriction when EnableGeofence is enabled..
string
Latitude coordinate of the tile for geographic restriction when EnableGeofence is enabled..
integer
Optional geofence radius in meters from the tile coordinates; use it when EnableGeofence is enabled..
string
Legacy success-message setting; the current tile execution service returns action-specific messages instead..
string
Legacy error-message setting; the current tile execution service returns action-specific messages instead..
integer[]
List of resources for which the customer must have a current booking to use this tile; an empty list imposes no resource-booking restriction..
integer[]
List of plans the customer must hold through an active contract to use this tile; an empty list imposes no plan restriction..
integer[]
List of passes the customer must hold to use this tile; an empty list imposes no pass restriction..
integer[]
List of desks or offices the customer or their paying member must hold through an active contract to use this tile; an empty list imposes no desk restriction..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the creation.
object
Contains the
Id of the newly created record.boolean
true if the automationtile was created successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response