Skip to main content
POST
/
properties
Create a property
curl --request POST \
  --url https://sitevisit.app/api/v1/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "address": "<string>",
  "notes": "<string>",
  "icon_emoji": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "isSample": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "visitCount": 123,
  "openItemCount": 123,
  "address": "<string>",
  "notes": "<string>",
  "iconEmoji": "<string>",
  "coverImageUrl": "<string>"
}

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
​
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
​
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