Visitors
Create Visitor
Create a new Visitor record.
POST
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
eVisitorSource — VisitorSource values
| Value | Name |
|---|---|
| 1 | Administrator |
| 2 | NexIO |
| 3 | Customer |
eVisitorHostApprovalStatus — HostApprovalStatus values
eVisitorHostApprovalStatus — HostApprovalStatus values
| Value | Name |
|---|---|
| 1 | NotRequired |
| 2 | Requested |
| 3 | Rejected |
| 4 | AcceptedAndHold |
| 5 | AcceptedAndGrant |
Request Body
Required Fields
Business Id.
Visitor full name.
Visitor email.
Expected arrival date and time.
Optional Fields
Coworker Id.
Visitor source. Defaults to
eVisitorSource.Administrator. See eVisitorSource enum above.Host approval status. Defaults to
eVisitorHostApprovalStatus.NotRequired. See eVisitorHostApprovalStatus enum above.Location checked in at.
Notes.
Customer notes.
Reason for visit.
Visitor company name.
Visitor phone number.
Whether the visitor has arrived.
Actual arrival date.
Departure date.
Notified.
Internal.
Whether this is a tour visit.
Whether the visitor has agreed to terms.
Whether the tour is confirmed.
Access Control Scheduled Job Id.
Check in the visitor now.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the visitor was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response