Documentation | API Reference

Feature Overview

A commercial proposal is a professional property presentation that you can send to a potential tenant via email. The recipient receives a link to a page with detailed property information, photos, characteristics, and a feedback form.

Key Features

Complete property information
Photo and video gallery
Property characteristics and parameters
Expenses and utilities information
Landlord's property inventory
Feedback form for the recipient
View and response tracking
Support for 4 languages (UK, EN, RU, PL)

Access Permissions

Only property owners and their representatives can send commercial proposals.

Role	Send	View List	Delete
Landlord	Yes	Yes	Yes
Landlord Agent	Yes	Yes	Yes
Tenant	No	No	No

How to Send a Proposal

1

Open the Property

Navigate to the property page for which you want to create a commercial proposal.

2

Click the Send Button

On the property page, find the button with the envelope icon (📨) or select "Commercial Proposal" from the actions menu.

3

Fill Out the Form

Enter the recipient's email and name, select the display language and currency. Optionally add a cover message.

4

Select Expiration Period

Specify how many days the proposal will be active: 7, 14, 30, or 60 days. After expiration, the link will become unavailable.

5

Send the Proposal

Click the "Send" button. The recipient will receive an email with a link to the proposal page.

Form Fields

Field	Required	Description
Recipient email	Yes	Email address to which the proposal letter will be sent
Recipient name	Yes	Recipient's name for email personalization
Display Currency	No	Currency for displaying prices and values on the proposal page
Cover message	No	Personal message from you that will be shown in the email and on the proposal page
Document language	Yes	Interface language for the email and proposal page
Link valid for (days)	Yes	Number of days the link will be active (7, 14, 30, or 60 days)

What's Included in the Proposal

The commercial proposal page automatically includes all public property information:

Property Information

Name, address, property type

Photos & Videos

Gallery with fullscreen viewing

Characteristics

Area, floor, number of rooms and other parameters

Communications

Internet, gas, electricity and other connections

Expenses

Utilities and their costs

Assets

Landlord's furniture and equipment

Proposal Statuses

The system automatically tracks the status of each proposal:

Sent

Email sent, recipient hasn't opened the link yet

Viewed

Recipient viewed the proposal page

Responded

Recipient left a response via the form

Expired

The proposal has expired

What the Recipient Sees

The commercial proposal recipient goes through the following steps:

1

Receiving the Email

The recipient receives a professional email with the proposal description, your cover message, and a button to view details.

2

Viewing the Proposal

By clicking the link, the recipient sees a beautiful page with all property information, photo gallery, and characteristics.

3

Response

If the recipient is interested, they can leave a message and contact phone through the feedback form.

Feedback Form

When the recipient leaves a response, you receive an email notification with their contacts and message. The proposal status changes to "Responded".

Confidentiality

Important

Each email contains a confidentiality disclaimer. The recipient is warned that sharing property data with third parties is prohibited without written consent.

Viewing Results

The list of all sent proposals is available in the property menu. For each proposal, the following is displayed:

Column	Description
Recipient	Name and email of the proposal recipient
Sent at	Date and time the proposal was sent
Status	Current proposal status (sent, viewed, responded, expired)
Views	Number of views of the proposal page
Response	Response text and contact phone (if the recipient responded)

REST API

Commercial proposals are also available via REST API for integration with other systems.

Service layer note

API Endpoints

GET    /api/v1/properties/{id}/proposals           # List proposals
POST   /api/v1/properties/{id}/proposals           # Create and send
GET    /api/v1/properties/{id}/proposals/{pid}     # Proposal details
DELETE /api/v1/properties/{id}/proposals/{pid}     # Delete proposal
POST   /api/v1/properties/{id}/proposals/{pid}/resend # Resend

Request Example

Request body example (POST)

{
  "recipient_email": "[email protected]",
  "recipient_name": "John Doe",
  "locale": "uk",
  "currency_id": 1,
  "cover_message": "Personal message for the recipient",
  "expires_in_days": 14
}

Full API documentation is available in Swagger UI

Open API Documentation

Commercial Proposals