Create Visitor - Nexudus Platform

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

{
  "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

BusinessId

integer

required

ID of the business linked to this record.

FullName

string

required

Visitor full name.

string

required

Visitor email.

VisitorSource

integer

required

Visitor source. Defaults to eVisitorSource.Administrator.

HostApprovalStatus

integer

required

Host approval status. Defaults to eVisitorHostApprovalStatus.NotRequired.

ExpectedArrival

string

required

Expected arrival date and time.

Optional Fields

CoworkerId

integer

ID of the coworker linked to this record.

CheckedInAt

string

Location checked in at.

Notes

string

Optional notes or comments about this visitor.

CustomerNotes

string

Customer notes.

VisitReason

string

Reason for visit.

CompanyName

string

Visitor company name.

PhoneNumber

string

Visitor phone number.

Arrived

boolean

Whether the visitor has arrived.

ArrivalDate

string

Actual arrival date.

DepartureDate

string

Departure date.

Notified

boolean

Whether notified is enabled.

Internal

boolean

Whether internal is enabled.

IsTour

boolean

Whether this is a tour visit.

HasAgreedTerms

boolean

Whether the visitor has agreed to terms.

TourConfirmed

boolean

Whether the tour is confirmed.

AccessControlScheduledJobId

string

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

CheckInNow

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

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

Errors

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

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

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

​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