Create/Update Leases And Tenants
This endpoint creates or updates a lease and tenant records for it.
You must specify either a unit_id or unit_external_ref for your lease.
If the corresponding unit record does not exist, you must create it separately via the relevant unit/property endpoints.
Header
The authentication token for your request
Body
The parameters for the lease to update or create.
A list of tenants to be associated with the created or updated lease.
Response
Errors
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.
Status Code - 400
{
"error": {
"type": "missing_authorization",
"message": "Your request does not include an 'Authorization' header with a bearer token for your account."
}
}
Status Code - 401
{
"error": {
"type": "expired_token",
"message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
}
}
Status Code - 401
{
"error": {
"type": "invalid_authorization",
"message": "The bearer token you have provided in the 'Authorization' header is invalid."
}
}
Status Code - 400
Returned if neither a unit id or a unit external reference is passed in the request body
{
"error": {
"type": "no_unit",
"message": "No unit id or unit external reference provided."
}
}
Status Code - 400
Returned if a unit with the specified unit id or unit external reference could not be retrieved
{
"error": {
"type": "unit_not_found",
"message": "No unit with the provided unit id or unit external reference."
}
}