Skip to main content
PATCH
Update an invite

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

Invite ID

Body

application/json

Fields to update

coverage_level
enum<string>

Change the coverage tier for the bond, which sets the number of months of rent it protects, from low (lowest) to high (highest). It is resolved to a coverage package using the coverages set up for the property, and every tier is subject to property support and applicant screening.

Available options:
low,
medium,
high
Example:

"medium"

lease
object
metadata
object | null

Key-value object. Replaces the existing metadata in full; send null to clear it. Each key must be a string, and values can be strings, numbers, booleans, or null.

property_id
string

Move the invite to a different property. Must be sent together with unit_id or a complete lease.unit_address.

Example:

"prop_ve2x7i0j6psdizy7"

unit_id
string

Move the invite to a different unit. Can't be sent together with lease.unit_address.

Example:

"unit_u7yr0vt3r9yk0c"

Response

OK

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"