Create AccessToken

Create a new AccessToken record.

POST /api/spaces/accesstokens

Create AccessToken

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/accesstokens \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "AccessCode": "<string>",
  "MinutesIncluded": 123
}
'

200

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

WiFi Access Tokens provide unique network access codes for customers and visitors. They work alongside the Mikrotik, IronWifi, and Layer8 integrations. Access tokens can be shared with customers and visitors as part of visitor and booking confirmation emails. Each token includes a number of minutes of WiFi access and, optionally, an expiration date and user limit.

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 AccessToken-Create role.

Request Body

Required Fields

BusinessId · integer · required

Business Id.

AccessCode · string · required

Unique network access code used to connect to WiFi.

MinutesIncluded · integer · required

Total minutes of WiFi access included in this token.

Optional Fields

Description · string

Free-text description of this access token.

ValidFrom · string

Start date from which this token can be used.

ValidTo · string

Expiration date after which this token is no longer valid.

UserLimit · integer

Maximum number of users that can use this token simultaneously.

MacAddress · string

MAC address of the device associated with this token.

BookingGuid · string

Booking Guid.

VisitorGuid · string

Visitor Guid.

Code Examples

cURL

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

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

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "AccessToken was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "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.

Show child attributes

AttemptedValue · any

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

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "AccessCode: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "AccessCode"
    }
  ],
  "WasSuccessful": false
}