Update Visitor - Nexudus Platform

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

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

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.

HostApprovalStatus

integer

required

Host approval status.

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

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the update.

Value

object

Contains the Id of the updated record.

WasSuccessful

boolean

true if the visitor was updated successfully.

Errors

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

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
}

Delete VisitorDelete an existing Visitor record by its Id.

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

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