POST residentapi/visitors

Insert a new visitor

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UnitId	Connect Unit Id	integer	Required
PropertyId	Connect Property Id	integer	Required
FirstName	First Name	string	Required
LastName	Last Name	string	Required
StartDate	Start Date	date	Required
EndDate	End Date	date	Required
Type	Guest Type. Guest or Contractor	string	Required
AccessHoursKey	Access Hours Key. AA, NA, BH, XH, WE	string	Required
Category	Visitor category. Required for guests and must contain one of these (Permanent, Temporary, Overnight, OneTime, LongTerm). Contractors not required and can contain any value.	string	None.
VisitorOfResidentId	Visitor Of Resident Id	integer	None.
CompanyName	Company Name. Required if visitor type is contractor.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "unitId": 1,
  "propertyId": 2,
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "startDate": "2025-12-24T09:18:17.7882591-05:00",
  "endDate": "2025-12-24T09:18:17.7882591-05:00",
  "type": "sample string 5",
  "accessHoursKey": "sample string 6",
  "category": "sample string 7",
  "visitorOfResidentId": 1,
  "companyName": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Visitor

Name	Description	Type	Additional information
VisitorId	Visitor Id. Unique identifier.	integer	None.
FirstName	First Name	string	None.
LastName	Last Name	string	None.
StartDate	Start Date	date	None.
EndDate	End Date	date	None.
PropertyId	Connect Property Id	integer	None.
UnitId	Connect Unit Id	integer	None.
Category	Visitor Category. Permanent, Temporary, Overnight, OneTime, LongTerm, etc	string	None.
Type	Visitor Type. Guest or Contractor	string	None.
AccessHoursKey	Access Hours Key. Possible values: AA, NA, BH, XH, WE	string	None.
AccessHours	Access Hours Display. Possible values: Access Anytime, No Access, Business Hours (M-F 9a-5p), Extended Hours (M-F 6a-8p), Weekends (Sat-Sun Anytime)	string	None.
VisitorOfResidentId	Visitor Of Resident Id	integer	None.
CompanyName	Company Name	string	None.

Response Formats

application/json, text/json

Sample:

{
  "visitorId": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "startDate": "2025-12-24T09:18:17.7882591-05:00",
  "endDate": "2025-12-24T09:18:17.7882591-05:00",
  "propertyId": 4,
  "unitId": 5,
  "category": "sample string 6",
  "type": "sample string 7",
  "accessHoursKey": "sample string 8",
  "accessHours": "sample string 9",
  "visitorOfResidentId": 1,
  "companyName": "sample string 10"
}