Process tenant exit

Processes a tenant exit by setting the exit date on a profile contract.

A profile contract represents the link between a tenant (profile) and a leasing contract,
including their share of rent and their entry/exit dates.

This endpoint allows you to record when a tenant is leaving the property by setting
the exit_date on their profile contract. The exit_date must be after the entry_date.

Optionally, you can attach an amendment document (avenant) by providing a URL to the file.
The amendment will be automatically stored in the tenant's document directory structure.

Parameters:

  • exit_date (required): The date the tenant will exit the property. Must be after entry_date.
  • amendment_url (optional): URL to an amendment PDF document to attach to the contract.

Validation:

  • The exit_date must be after the tenant's entry_date
  • If an amendment_url is provided, the file must be downloadable and valid
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Leasing contract unique identifier

string
required

Profile contract unique identifier

Query Params
date
required

The exit date for the tenant (must be after entry_date)

string

URL to an amendment PDF document to attach

Responses

404

leasing contract or profile contract not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json