Create property

POST

/api/properties

curl --request POST \
  --url https://api.getvespy.com/api/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "city": "example", "initialUnit": { "bathrooms": 1, "bedrooms": 1, "feeTemplates": [ { "amountCents": 1, "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultDueDay": 1, "label": "example" } ], "monthlyRentCents": 1, "status": "occupied", "unitNumber": "example" }, "name": "example", "occupiedUnits": 1, "ownerIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "postalCode": "example", "state": "example", "streetLine1": "example", "streetLine2": "example", "units": 1 }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

city

required

string

>= 1 characters <= 120 characters

initialUnit

object

bathrooms

required

integer

bedrooms

required

integer

feeTemplates

Array<object>

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

defaultDueDay

integer

nullable >= 1 <= 31

label

required

string

>= 1 characters <= 160 characters

monthlyRentCents

required

integer

>= 1

status

required

string

Allowed values: occupied vacant maintenance

unitNumber

string

nullable <= 32 characters

name

required

string

>= 1 characters <= 120 characters

occupiedUnits

required

integer

ownerIds

Array<string>

unique items

postalCode

required

string

/^\d{5}(?:-\d{4})?$/

state

required

string

>= 2 characters <= 2 characters

streetLine1

required

string

>= 1 characters <= 160 characters

streetLine2

string

nullable >= 1 characters <= 160 characters

units

required

integer

>= 1

Responses

201

Default Response

Media typeapplication/json

object

notes

required

Array<object>

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

createdByUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

createdByUserId

required

string format: uuid

nullable

entityId

required

string format: uuid

entityType

required

string

Allowed values: property unit owner tenant lease vendor work_order

id

required

string format: uuid

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

property

required

object

city

required

string

createdAt

required

string format: date-time

id

required

string format: uuid

name

required

string

occupiedUnits

required

integer

openWorkOrderCount

integer

overduePostedRentCents

integer

ownerIds

required

Array<string>

unique items

postalCode

required

string

/^\d{5}(?:-\d{4})?$/

relations

object

owners

required

Array<object>

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

state

required

string

>= 2 characters <= 2 characters

streetLine1

required

string

>= 1 characters <= 160 characters

streetLine2

required

string

nullable >= 1 characters <= 160 characters

units

required

integer

>= 1

Example

{
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ]
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}