Rental applications

Remind an applicant to finish

Emails the applicant a link back to their unfinished application. Only legal while the application is a draft — there is nothing left for the applicant to do once it is submitted or retracted. Requires the rental_applications:write permission.

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

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

204 · The reminder was handed to the notification system. The response has no body.

400 · The application is not a `draft`. Reminders are only sent for applications the applicant can still work on.

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.

204 does not mean the email was delivered

A delivery failure inside the notification system is logged and swallowed, so this endpoint reports success as long as the application was in a state that allows a reminder. It also does not check that the applicant has an email address.