Skip to content
Vespy API

Create a unit

POST
/api/units
curl --request POST \
  --url https://api.getvespy.com/api/units \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "accessInstructions": "example", "bathrooms": 1, "bedrooms": 1, "buildingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "feeTemplates": [ { "amountCents": 1, "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultDueDay": 1, "label": "example" } ], "floorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "monthlyRentCents": 1, "propertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rentableSqft": 1, "spaceType": "residential_unit", "status": "occupied", "unitNumber": "example", "usableSqft": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
accessInstructions
string
>= 1 characters <= 2000 characters
bathrooms
integer
nullable
bedrooms
integer
nullable
buildingId
string format: uuid
nullable
description
string
>= 1 characters <= 5000 characters
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
floorId
string format: uuid
nullable
monthlyRentCents
integer
nullable >= 1
propertyId
required
string format: uuid
rentableSqft
integer
nullable >= 1
spaceType
string
Allowed values: residential_unit office_suite retail industrial storage parking other
status
required
string
Allowed values: occupied vacant maintenance
unitNumber
string
nullable >= 1 characters <= 32 characters
usableSqft
integer
nullable >= 1

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
feeTemplates
required
Array<object>
object
amountCents
required
integer
>= 1
categoryId
required
string format: uuid
createdAt
required
string format: date-time
defaultDueDay
required
integer
nullable >= 1 <= 31
id
required
string format: uuid
label
required
string
>= 1 characters <= 160 characters
organizationId
required
string format: uuid
unitId
required
string format: uuid
updatedAt
required
string format: date-time
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
unit
required
object
accessInstructions
required
string
nullable
bathrooms
required
integer
nullable
bedrooms
required
integer
nullable
buildingId
required
string format: uuid
nullable
createdAt
required
string format: date-time
currentLease
object
endDate
required
string format: date
nullable
id
required
string format: uuid
leaseKind
string
Allowed values: residential commercial
rentCents
required
integer
>= 1
startDate
required
string format: date
status
required
string
Allowed values: draft active ended terminated
tenantId
required
string format: uuid
tenantName
required
string
>= 1 characters <= 160 characters
currentTenant
object
email
required
string format: email
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
description
required
string
nullable
floorId
required
string format: uuid
nullable
id
required
string format: uuid
monthlyRentCents
required
integer
nullable >= 1
openWorkOrderCount
integer
overduePostedRentCents
integer
propertyCity
required
string
propertyId
required
string format: uuid
propertyName
required
string
propertyPostalCode
required
string
/^\d{5}(?:-\d{4})?$/
propertyState
required
string
>= 2 characters <= 2 characters
propertyStreetLine1
required
string
>= 1 characters <= 160 characters
propertyStreetLine2
required
string
nullable >= 1 characters <= 160 characters
rentableSqft
required
integer
nullable >= 1
spaceType
required
string
Allowed values: residential_unit office_suite retail industrial storage parking other
status
required
string
Allowed values: occupied vacant maintenance
unitNumber
required
string
nullable >= 1 characters <= 32 characters
usableSqft
required
integer
nullable >= 1
Example
{
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ],
  "unit": {
    "currentLease": {
      "leaseKind": "residential",
      "status": "draft"
    },
    "spaceType": "residential_unit",
    "status": "occupied"
  }
}

400

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}