Rental applications

Delete a rental application

Soft-deletes a rental application so it stops appearing in lists and lookups. Allowed from any status, including after a decision has been made. Requires the rental_applications:delete permission.

DELETE

https://services.magicdoor.com/leasing/company-portal/rental-applications/{id}

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

idstringrequired

The rental application to work with. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · The application was deleted. The response has no body.

401 · The access token is missing, expired, or not valid.

403 · The caller is authenticated but does not hold the `rental_applications:delete` permission.

404 · No rental application with this id exists, or it belongs to another company. Both cases look identical so that ids cannot be probed across companies.

Retracting is usually what you want

Deleting removes the application from view entirely. To record that an applicant withdrew while keeping the application on file, use retract instead.

Request

curl --request DELETE \
  --url 'https://services.magicdoor.com/leasing/company-portal/rental-applications/1830472847398404096' \
  --header 'Authorization: Bearer <token>'

Response

{
  "type": "https://httpstatuses.com/401",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required to access this resource.",
  "traceId": "0HN7GK9C2M4PQ"
}