Create Visitor

POST

api

spaces

visitors

Create Visitor

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/visitors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FullName": "<string>",
  "Email": "<string>",
  "VisitorSource": 123,
  "HostApprovalStatus": 123,
  "ExpectedArrival": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "FullName": "<string>",
    "Email": "<string>",
    "VisitorSource": 123,
    "HostApprovalStatus": 123,
    "ExpectedArrival": "<string>"
}
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,
    FullName: '<string>',
    Email: '<string>',
    VisitorSource: 123,
    HostApprovalStatus: 123,
    ExpectedArrival: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/spaces/visitors', 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 Visitor represents a person visiting a location who is not a member. Visitors are registered with their name, contact details, expected arrival time, and the host (customer) they are visiting. Visitor management includes check-in/check-out tracking and optional host approval workflows.

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

Enums

eVisitorSource — VisitorSource values

Value	Name
1	Administrator
2	NexIO
3	Customer

eVisitorHostApprovalStatus — HostApprovalStatus values

Value	Name
1	NotRequired
2	Requested
3	Rejected
4	AcceptedAndHold
5	AcceptedAndGrant

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Visitor full name.

string

required

Visitor email.

integer

required

Visitor source. Defaults to eVisitorSource.Administrator.

integer

required

Host approval status. Defaults to eVisitorHostApprovalStatus.NotRequired.

string

required

Expected arrival date and time.

Optional Fields

integer

ID of the coworker linked to this record.

string

Location checked in at.

string

Optional notes or comments about this visitor.

string

Customer notes.

string

Reason for visit.

string

Visitor company name.

string

Visitor phone number.

boolean

Whether the visitor has arrived.

string

Actual arrival date.

string

Departure date.

boolean

Whether notified is enabled.

boolean

Whether internal is enabled.

boolean

Whether this is a tour visit.

boolean

Whether the visitor has agreed to terms.

boolean

Whether the tour is confirmed.

string

ID of the access control scheduled job associated with this record.

boolean

Check in the visitor now.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/visitors" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "FullName": "",
    "Email": "",
    "VisitorSource": 0,
    "HostApprovalStatus": 0,
    "ExpectedArrival": null
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/visitors',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      FullName: '',
      Email: '',
      VisitorSource: 0,
      HostApprovalStatus: 0,
      ExpectedArrival: null
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/visitors',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'FullName': '',
        'Email': '',
        'VisitorSource': 0,
        'HostApprovalStatus': 0,
        'ExpectedArrival': None
    }
)

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

array

null on success.

Example Response

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

Update VisitorUpdate an existing Visitor record.

Create Visitor

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/visitors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FullName": "<string>",
  "Email": "<string>",
  "VisitorSource": 123,
  "HostApprovalStatus": 123,
  "ExpectedArrival": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "FullName": "<string>",
    "Email": "<string>",
    "VisitorSource": 123,
    "HostApprovalStatus": 123,
    "ExpectedArrival": "<string>"
}
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,
    FullName: '<string>',
    Email: '<string>',
    VisitorSource: 123,
    HostApprovalStatus: 123,
    ExpectedArrival: '<string>'
  })
};

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