Skip to main content
POST
Create a property

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
name
string
required

Display name of the property.

Required string length: 1 - 200
address
string

Optional street address.

Maximum string length: 500
notes
string

Optional free-form notes (markdown allowed).

Maximum string length: 5000
icon_emoji
string

Optional emoji shown on the property card.

Maximum string length: 8

Response

Resource created.

id
string
required
name
string
required
isSample
boolean
required
isTest
boolean
required

True for objects created via a sv_test_* API key. Stripe-style test-mode flag — test data is never returned to live-mode callers and vice versa.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
visitCount
integer
required
openItemCount
integer
required
address
string | null
notes
string | null
iconEmoji
string | null
coverImageUrl
string | null