Rental applications

Send an application to owners

Generates the application PDF and emails it to one or more property owners, then reports which owners it reached. Requires the rental_applications:read permission.

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

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

ownerIdsstring[]required

The owners to email. At least one. Duplicates are collapsed before sending.

subjectstring

Subject line. Sent as an empty subject when omitted.

bodystring

Message body. Sent as an empty body when omitted.

Response

200 · The email run finished. Owners that could not be emailed are reported rather than failing the call.

fileIdstring

The generated PDF that was attached to the emails.

sentOwnerIdsstring[]

Owners the email was sent to.

skippedOwnerIdsstring[]

Owners that were skipped because they have no usable email address on file.

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

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

This sends the applicant's personal data to a third party

The attached PDF reproduces the application, including the Social Security number and date of birth. Check that sending it to the owner is something the applicant agreed to and your jurisdiction allows before calling this.