These docs are for v2.3. Click to read the latest docs for v3.0.

Create a Visit

Sample Request:

POST /api/v2.0/visits

This endpoint requires all data to be in the body of the request.

{
"entityType":"Occupancy",
"entityReference":"CLB 01-001",
"visitDate":"2024/01/15 12:00:00",
"visitTimeSlot": "AM", // Time is ignored on front end from visit date if provided
"visitType":"Generic Visit",
"visitNote":"First inspection",
"assignedTo":"niba fal"
}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1
string
required
length ≥ 1
date-time
required
string | null
string
required
length ≥ 1
string | null
string
required
length ≥ 1
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json