Lease tenants

Move a tenant into a lease

Puts a tenant onto the lease with a move-in date. Leave moveIn out to use the lease's own start date.

POST
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/tenants/{tenantId}

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

leaseIdstringrequired

The lease to change. A Snowflake id, sent as a decimal string.

example: 1830472847398404096
tenantIdstringrequired

The tenant to move. A Snowflake id, sent as a decimal string.

example: 1831856473920184832

Body

application/json

moveInstring · date

The date the tenant moves in. Defaults to the lease's start date when left out.

Response

200 · The tenant was added to the lease. No body is returned.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

401 · The access token is missing, expired, or not for this company.

404 · No lease or tenant matched the id, or it belongs to another company.