Skip to main content
id
string
required
Example:

"inv_01HQ8X"

invite_recipients
object[]
required
lease
object
required

The legal contract between a property manager and the tenant, as represented on invites. Identical to Lease, plus rent concession fields that are accepted when creating an invite and returned on invite responses. One of unit_address or unit_id is required.

object
string
required
Example:

"invite"

property_id
string
required
Example:

"prop_01HQ7A"

status
enum<string>
required
Available options:
created,
accepted,
canceled,
expired
Example:

"accepted"

application_id
string | null
Example:

"sd_01HQ8Z"

metadata
object | null

Optional key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.

obligee
string | null

The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.

Example:

"Rivermark Residential LLC"