Skip to content
Vespy API

Update lease details

PUT
/api/leases/{id}
curl --request PUT \
  --url https://api.getvespy.com/api/leases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalRecurringCharges": [ { "amountCents": 1, "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dayOfMonth": 1, "endDate": "2026-04-15", "label": "example", "startDate": "2026-04-15" } ], "endDate": "2026-04-15", "lateFeeAmountCents": 1, "lateFeeGraceDays": 1, "lateFeePercentBps": 1, "lateFeeType": "none", "moveInDate": "2026-04-15", "occupants": [ { "isPrimary": true, "moveInDate": "2026-04-15", "moveOutDate": "2026-04-15", "providerRole": "example", "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ], "propertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rentCents": 1, "rentChargeDay": 1, "startDate": "2026-04-15", "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "termType": "fixed", "unitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Any of:
object
additionalRecurringCharges
Array<object>
object
amountCents
required
integer
>= 1
categoryId
required
string format: uuid
dayOfMonth
integer
>= 1 <= 31
endDate
string format: date
nullable
label
required
string
>= 1 characters <= 160 characters
startDate
string format: date
endDate
string format: date
nullable
lateFeeAmountCents
integer
nullable >= 1
lateFeeGraceDays
integer
lateFeePercentBps
integer
nullable >= 1
lateFeeType
string
Allowed values: none flat percent
moveInDate
string format: date
occupants
Array<object>
<= 50 items
object
isPrimary
required
boolean
moveInDate
required
string format: date
nullable
moveOutDate
required
string format: date
nullable
providerRole
required
string
nullable
tenantId
required
string format: uuid
propertyId
required
string format: uuid
rentCents
integer
>= 1
rentChargeDay
integer
>= 1 <= 31
startDate
string format: date
tenantId
string format: uuid
termType
string
Allowed values: fixed month_to_month
unitId
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
lease
required
object
createdAt
required
string format: date-time
daysUntilExpiry
required
integer
nullable
deletedAt
required
string format: date-time
nullable
endDate
required
string format: date
nullable
id
required
string format: uuid
lateFeeAmountCents
required
integer
nullable >= 1
lateFeeGraceDays
required
integer
lateFeePercentBps
required
integer
nullable >= 1
lateFeeType
required
string
Allowed values: none flat percent
moveInDate
required
string format: date
occupants
required
Array<object>
object
isPrimary
required
boolean
moveInDate
required
string format: date
nullable
moveOutDate
required
string format: date
nullable
providerRole
required
string
nullable
tenantId
required
string format: uuid
tenantName
required
string
>= 1 characters <= 160 characters
organizationId
required
string format: uuid
overduePostedRentCents
integer
propertyId
required
string format: uuid
propertyName
required
string
renewedFromLeaseId
required
string format: uuid
nullable
rentCents
required
integer
>= 1
rentChargeDay
required
integer
>= 1 <= 31
signedAt
required
string format: date-time
nullable
startDate
required
string format: date
status
required
string
Allowed values: draft active ended terminated
tenantId
required
string format: uuid
tenantName
required
string
termType
required
string
Allowed values: fixed month_to_month
terminationDate
required
string format: date
nullable
unitId
required
string format: uuid
unitNumber
required
string
nullable
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
recurringChargeRules
required
Array<object>
object
amountCents
required
integer
>= 1
categoryId
required
string format: uuid
createdAt
required
string format: date-time
dayOfMonth
required
integer
>= 1 <= 31
endDate
required
string format: date
nullable
frequency
required
string
Allowed values: monthly
id
required
string format: uuid
kind
required
string
Allowed values: rent fee
label
required
string
>= 1 characters <= 160 characters
leaseId
required
string format: uuid
nullable
organizationId
required
string format: uuid
propertyId
required
string format: uuid
nullable
startDate
required
string format: date
status
required
string
Allowed values: draft active paused ended
tenantId
required
string format: uuid
nullable
unitId
required
string format: uuid
nullable
updatedAt
required
string format: date-time
Example
{
  "lease": {
    "lateFeeType": "none",
    "status": "draft",
    "termType": "fixed"
  },
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ],
  "recurringChargeRules": [
    {
      "frequency": "monthly",
      "kind": "rent",
      "status": "draft"
    }
  ]
}

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"
}