Create AccessToken

POST

api

spaces

accesstokens

Create AccessToken

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
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/accesstokens"

payload = {
    "BusinessId": 123,
    "AccessCode": "<string>",
    "MinutesIncluded": 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, AccessCode: '<string>', MinutesIncluded: 123})
};

fetch('https://spaces.nexudus.com/api/spaces/accesstokens', 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>"
    }
  ]
}

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

integer

required

ID of the business linked to this record.

string

required

Unique network access code used to connect to WiFi.

integer

required

Total minutes of WiFi access included in this token.

Optional Fields

string

Free-text description of this access token.

string

Start date from which this token can be used.

string

Expiration date after which this token is no longer valid.

integer

Maximum number of users that can use this token simultaneously.

string

MAC address of the device associated with this token.

string

Unique identifier (GUID) for the booking.

string

Unique identifier (GUID) for the visitor.

Code Examples

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
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/accesstokens',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'AccessCode': '',
        'MinutesIncluded': 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 accesstoken was created successfully.

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": "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": "AccessCode: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "AccessCode"
    }
  ],
  "WasSuccessful": false
}

Update AccessTokenUpdate an existing AccessToken record.

Create AccessToken

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
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/accesstokens"

payload = {
    "BusinessId": 123,
    "AccessCode": "<string>",
    "MinutesIncluded": 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, AccessCode: '<string>', MinutesIncluded: 123})
};

fetch('https://spaces.nexudus.com/api/spaces/accesstokens', 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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400