Create Sensor

POST

api

sys

sensors

Create Sensor

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/sensors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Reference": "<string>",
  "SensorType": 123,
  "DataStrategy": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Reference": "<string>",
    "SensorType": 123,
    "DataStrategy": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Reference: '<string>',
    SensorType: 123,
    DataStrategy: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A Sensor represents a physical IoT sensor deployed in a location for monitoring environmental conditions or occupancy. Sensors can detect presence, count people, measure temperature, humidity, noise, CO2 levels, and other metrics.

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.

Enums

eSensorType — SensorType values

Value	Name
1	PresenceDetection
2	PeopleCounter
3	Temperature
4	Humidity
5	Light
6	Noise
7	CO2
8	VolatileOrganicCompounds
9	HarmfulParticulates
10	Touch
11	Water
12	AtmosphericPressure
13	Power
14	OpenClosed
99	Other

eSensorDataStrategy — DataStrategy values

Value	Name
1	Polling
2	Endpoint
3	DisruptiveTechnologies
4	Pressac

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this sensor.

string

required

The reference value for this sensor.

integer

required

The sensor type value for this sensor.

integer

required

The data strategy value for this sensor.

Optional Fields

integer[]

List of desks linked to this record.

integer[]

List of resources linked to this record.

integer

ID of the canned response linked to this record.

string

The unit value for this sensor.

boolean

Whether this sensor is currently active.

string

The payload data path value for this sensor.

string

The action trigger function value for this sensor.

string

The value function value for this sensor.

boolean

Whether action send email alert is enabled.

string

The alert email address value for this sensor.

string

The webhook url value for this sensor.

boolean

Whether action update desk availability is enabled.

boolean

Whether action update resource availability is enabled.

boolean

Whether action update booking occupancy is enabled.

boolean

Whether action send customer email alert is enabled.

boolean

Whether action booking start is enabled.

boolean

Whether action booking terminate is enabled.

boolean

Whether action check in or out is enabled.

boolean

Whether action make http request is enabled.

boolean

Whether show in now dashboard is enabled.

boolean

Whether show in portal is enabled.

string

The shared secret value for this sensor.

string

The api key value for this sensor.

string

The username value for this sensor.

string

The password value for this sensor.

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": "",
    "SensorType": 0,
    "DataStrategy": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/sensors',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Reference: '',
      SensorType: 0,
      DataStrategy: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/sensors',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Reference': '',
        'SensorType': 0,
        'DataStrategy': 0
    }
)

data = response.json()

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 sensor was created successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update SensorUpdate an existing Sensor record.

Create Sensor

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/sensors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Reference": "<string>",
  "SensorType": 123,
  "DataStrategy": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Reference": "<string>",
    "SensorType": 123,
    "DataStrategy": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Reference: '<string>',
    SensorType: 123,
    DataStrategy: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400