Rental applications

Ask the applicant for more information

Emails the applicant a link that reopens their application so they can correct or add to it, and records the request. The link is valid for three days. Only legal while the application is submitted. Requires the rental_applications:write permission.

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

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

Body

application/json

reasonstring

Why you are asking, in your own words. Shown to the applicant in the email and on the form. At most 2500 characters. Omit it and the applicant gets the generic wording with no reason line.

Response

204 · The request was created and the email sent. The response has no body.

400 · The application is not `submitted`, or it has no email address to send the request to.

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

403 · The caller is authenticated but does not hold the `rental_applications:write` 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.

An open request shows up on the list

While the request is open and unexpired, the application appears in the pausedForInfo bucket on List rental applications.