POST
Cancel 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 cancel lease.

note
string | null

Optional note captured by the operator.

Maximum string length: 1000

Response

Cancelled 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.