Add a co-tenant or an occupant to a lease

POST

/api/leases/{leaseId}/occupants

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

• Production
• Development
• Local

A co-tenant is an existing tenant (tenantId) or a new one (tenant). An occupant is a name and, if the lease states it, a relationship; occupants are never tenant records.

Authorizations

• bearerAuth

Parameters

Path Parameters

leaseId

required

string format: uuid

Request Body^required

Media typeapplication/json

Any of:

object

An existing tenant becomes a co-tenant.

object

moveInDate

string format: date

nullable

notes

string

nullable >= 1 characters <= 2000 characters

role

required

string

Allowed values: co_tenant

tenantId

required

string format: uuid

object

A new tenant, created as a co-tenant on this lease.

object

moveInDate

string format: date

nullable

notes

string

nullable >= 1 characters <= 2000 characters

role

required

string

Allowed values: co_tenant

tenant

required

object

billingAddress

object

city

required

string

>= 1 characters <= 120 characters

country

required

string

>= 2 characters <= 2 characters

line1

required

string

>= 1 characters <= 160 characters

line2

string

nullable >= 1 characters <= 160 characters

postalCode

required

string

>= 1 characters <= 20 characters

state

required

string

>= 1 characters <= 80 characters

dbaName

string

nullable

email

string format: email

nullable

emergencyContactName

string

nullable

emergencyContactPhone

string

nullable

emergencyContactRelationship

string

nullable

fullName

required

string

>= 1 characters <= 160 characters

isActive

boolean

kind

string

Allowed values: person company

legalName

string

nullable

phone

string

nullable

preferredLanguage

string

>= 2 characters <= 32 characters

userId

string format: uuid

nullable

object

Someone who lives there without signing. Never a tenant record, a portal user or a notice recipient.

object

fullName

required

string

>= 1 characters <= 160 characters

moveInDate

string format: date

nullable

notes

string

nullable >= 1 characters <= 2000 characters

relationship

string

nullable >= 1 characters <= 80 characters

role

required

string

Allowed values: occupant

Responses

201

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