Accept a move-out request

Approves a tenant's request to leave and puts their date onto the lease. The request moves to approved.

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 the request is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

moveOutRequestIdstringrequired

The request to accept, from the list endpoint. A Snowflake id, sent as a decimal string.

example: 1847019384756201984

Response

200 · The request, now approved.

idstring

Id of the move-out request. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease the request is on. A Snowflake id, sent as a decimal string.

statusenum<string>

Where the request stands: requested while it is waiting on the company, approved once accepted, rejected once turned down, retracted if the tenant withdrew it.

requestedrejectedapprovedretracted

moveOutDatestring · date-time

The date the tenant wants to leave, in the company's timezone.

reasonstring

Why the tenant is leaving, when they gave a reason.

createdDatestring · date-time

When the request was made, in the company's timezone.

tenantobject

The tenant who asked. Absent when the company set the date itself.

Accept a move-out request

Authorization

Path parameters

Response

200 · The request, now approved.

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

404 · No move-out request matched the id, or it belongs to another company.