Skip to main content
POST
/
api
/
sys
/
sensors
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​
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 Sensor-Create role.

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Name.
​
Reference
string
required
Reference.

​
Optional Fields

​
Desks
integer[]
Desks.
​
Resources
integer[]
Resources.
​
CannedResponseId
integer
Canned Response Id.
​
Unit
string
Unit.
​
Active
boolean
Active.
​
SensorType
integer
Sensor Type. See eSensorType enum above.
​
DataStrategy
integer
Data Strategy. See eSensorDataStrategy enum above.
​
PayloadDataPath
string
Payload Data Path.
​
ActionTriggerFunction
string
Action Trigger Function.
​
ValueFunction
string
Value Function.
​
ActionSendEmailAlert
boolean
Action Send Email Alert.
​
AlertEmailAddress
string
Alert Email Address.
​
WebhookUrl
string
Webhook Url.
​
ActionUpdateDeskAvailability
boolean
Action Update Desk Availability.
​
ActionUpdateResourceAvailability
boolean
Action Update Resource Availability.
​
ActionUpdateBookingOccupancy
boolean
Action Update Booking Occupancy.
​
ActionSendCustomerEmailAlert
boolean
Action Send Customer Email Alert.
​
ActionBookingStart
boolean
Action Booking Start.
​
ActionBookingTerminate
boolean
Action Booking Terminate.
​
ActionCheckInOrOut
boolean
Action Check In Or Out.
​
ActionMakeHttpRequest
boolean
Action Make Http Request.
​
ShowInNowDashboard
boolean
Show In Now Dashboard.
​
ShowInPortal
boolean
Show In Portal.
​
SharedSecret
string
Shared Secret.
​
ApiKey
string
Api Key.
​
Username
string
Username.
​
Password
string
Password.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/sensors" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Reference": ""
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the sensor was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Sensor was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}