Update Visitor

PUT

api

spaces

visitors

Update Visitor

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

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "FullName": "<string>",
    "Email": "<string>",
    "VisitorSource": 123,
    "HostApprovalStatus": 123,
    "ExpectedArrival": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    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>"
    }
  ]
}

Updates an existing Visitor record. You must include the Id of the record to update along with all required fields.

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-Edit 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

The Id of the Visitor record to update.

integer

required

ID of the location this visitor is visiting; required..

string

required

Visitor’s full name; required..

string

required

Visitor’s email address; required and validated as an email address..

integer

required

How the visitor was registered: Administrator for staff and Admin Agent registrations, Customer for registrations from the customer portal, app, or AI assistant, or NexIO for the reception tablet app; booking guests are synchronized from their booking..

integer

required

Host approval workflow state: NotRequired, Requested, Rejected, AcceptedAndHold, or AcceptedAndGrant; manage pending approvals with the dedicated visitor approval tool..

string

required

Expected arrival date and time, stored in UTC and required when creating a visitor..

Optional Fields

integer

ID of the customer hosting this visitor; required..

string

Check-in location/value; use Arrived, ArrivalDate, and DepartureDate for the visitor’s current visit status..

string

Optional internal staff notes about the visitor, limited to 1,024 characters and not shown to the visitor..

string

Optional reason the visitor is coming to the location..

string

Optional company or organization the visitor represents..

string

Optional phone number for contacting the visitor..

boolean

Internal notification state set after the visitor has checked in..

boolean

Internal booking-visitor classification set when the visitor matches a customer and the location excludes known customers from visitor registration..

boolean

Whether this visit is a tour; tour requests from the public portal or AI assistant create tour visitors, which require a hosting customer and use the tour confirmation workflow..

string

Internal identifier for the access-control scheduling job associated with this visitor..

boolean

Whether to check the visitor in immediately when creating the record; also sets ArrivalDate to the current UTC time and clears any departure time..

boolean

Internal flag set for booking visitors whose email already belongs to a customer at the location..

Code Examples

curl -X PUT \
  "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,
    "Id": 87654321
}'

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

const data = await response.json();

import requests

response = requests.put(
    '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,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the visitor was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Visitor was successfully updated.",
  "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 Visitor

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

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "FullName": "<string>",
    "Email": "<string>",
    "VisitorSource": 123,
    "HostApprovalStatus": 123,
    "ExpectedArrival": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    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