PATCH
Update lease

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

lease_id
string<uuid>
required

Lease ID

Body

application/json

Lease lifecycle fields such as room, renter, rent, deposit, occupant count, dates, and reason.

Request payload for update lease.

monthly_rent
string
required

Monthly rent amount for the lease.

Example:

"3000000"

deposit_amount
string
required

Deposit amount recorded for the lease.

Example:

"3000000"

end_date
string<date> | null

Lease or report end date.

number_of_occupants
integer<int32> | null

Number of occupants assigned to the room or lease.

Required range: x >= 1
note
string | null

Optional note captured by the operator.

Maximum string length: 1000

Response

Updated lease

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.