API Documentation - Online Leasing Link

Table of Contents

Online Leasing Link

GET /api/v2/onlineleasing-link/

Redirects to a Funnel online leasing application. The data in the online leasing application will be pre-filled based on the provided parameters (property, unit, move in date, and lease term).

Required URI Parameters

• myOlePropertyId
  • String. Required. Your community integration id.
• companyID
  • Integer. Required. Your Funnel company id.

Other URI Parameters

• sLeaseTerm
  • Integer. Lease term duration in months.
• MoveInDate
  • String. It represents the move in date, must be ìn format MM/DD/YYYY, example: 12/30/2022.
• UnitID
  • Integer. Your internal unit id.

Responses

• 302 redirect response that will redirect to an online leasing app if provided parameters are valid
• 400 error response if date is invalid format
• 404 error response if community or unit integration do not exist