Skip to main content
POST
Create a site visit

Authorizations

Authorization
string
header
required

Bearer API key. Two modes: sv_live_* for production data, sv_test_* for a parallel sandbox dataset that doesn't count against plan limits. Issued from Settings → Developers in the SiteVisit app.

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
isTest
boolean
required

True for objects created via a sv_test_* API key. Mirrors the parent Property's mode.

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