Record a move-in, move-out or release, or correct someone on a lease

PATCH

/api/lease-occupants/{id}

curl --request PATCH \
  --url https://api.getvespy.com/api/lease-occupants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fullName": "example", "moveInDate": "2026-04-15", "moveOutDate": "2026-04-15", "notes": "example", "relationship": "example", "releasedOn": "2026-04-15" }'

• Production
• Development
• Local

Moving a co-tenant out does not release them from liability; set releasedOn for that. The primary tenant cannot be moved out while the lease is draft or active.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

fullName

Occupants only; a co-tenant’s name is their tenant record’s.

string

>= 1 characters <= 160 characters

moveInDate

string format: date

nullable

moveOutDate

string format: date

nullable

notes

string

nullable >= 1 characters <= 2000 characters

relationship

string

nullable >= 1 characters <= 80 characters

releasedOn

Co-tenants only: the day they were released from liability for the rent.

string format: date

nullable

Example^generated

{
  "fullName": "example",
  "moveInDate": "2026-04-15",
  "moveOutDate": "2026-04-15",
  "notes": "example",
  "relationship": "example",
  "releasedOn": "2026-04-15"
}

Responses

200

Default Response

Media typeapplication/json

object

occupant

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

isPrimary

required

boolean

moveInDate

required

string format: date

nullable

moveOutDate

required

string format: date

nullable

notes

required

string

nullable <= 2000 characters

providerRole

required

string

nullable

relationship

required

string

nullable <= 80 characters

releasedOn

required

string format: date

nullable

removedAt

required

string format: date-time

nullable

role

required

string

Allowed values: co_tenant occupant

tenantId

required

string format: uuid

nullable

tenantName

required

string

nullable >= 1 characters <= 160 characters

Example

{
  "occupant": {
    "role": "co_tenant"
  }
}

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

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

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