Skip to main content
POST
/
site-visits
Create a site visit
curl --request POST \
  --url https://sitevisit.app/api/v1/site-visits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "property_id": "<string>",
  "title": "<string>",
  "visit_date": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "notes": "<string>"
}
'
{
  "id": "<string>",
  "propertyId": "<string>",
  "propertyName": "<string>",
  "title": "<string>",
  "visitDate": "2023-11-07T05:31:56Z",
  "recipients": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "actionItemCount": 123,
  "openActionItemCount": 123,
  "publicReportUrl": "<string>",
  "summary": "<string>",
  "notes": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Optional idempotency key, scoped to the authenticated account. Repeating a write with the same key + same body returns the original response; same key + different body returns 422 idempotency_key_in_use.

Maximum string length: 255

Body

application/json
​
property_id
string
required
​
title
string
required
Required string length: 1 - 200
​
visit_date
string<date-time>
​
summary
string
Maximum string length: 5000
​
notes
string
Maximum string length: 10000

Response

Resource created.

​
id
string
required
​
propertyId
string
required
​
propertyName
string
required
​
title
string
required
​
status
enum<string>
required
Available options:
DRAFT,
PROCESSING,
READY,
SENT,
DONE
​
visitDate
string<date-time>
required
​
recipients
string[]
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
actionItemCount
integer
required
​
openActionItemCount
integer
required
​
publicReportUrl
string<uri>
required
​
summary
string | null
​
notes
string | null
​
sentAt
string<date-time> | null
​
completedAt
string<date-time> | null