Skip to main content

Invite applicant

POST 
/rental-files/invite/

Invite an Applicant for a Rental File.

This endpoint allows the authenticated user to invite an applicant to apply for a specific rental file. An invitation will be sent to the applicant's email, allowing them to access and submit their application.

🔒 Authentication​

This endpoint require a valid OAuth2 Bearer

It supports account impersonation within Organization's sub-accounts using X-Eaz-Account-Id Header.

  • If the X-Eaz-Account-Id header is provided and the user has access rights to that sub-account, the impersonation context is applied.
  • Otherwise, the user's own account context is used.

Scopes :​

User must provide one of the following scopes:

  • admin
  • staff
  • user
  • org:admin
  • org:staff
  • org:user
  • rental_file:write

Request​

Responses​

Successful Response