← Home Changelog

Changelog

All notable changes to this API will be documented in this file.

The format follows Keep a Changelog and adheres to Semantic Versioning.

27 March 2026

Listing Insights - Impressions & Leads API:We have introduced a new suite of endpoints within the Listings API and Profolio API (Phase 2) to provide performance data for your listings.This update enables programmatically retrieving visibility and engagement metrics.Key Features:
- Impression Tracking : Access data on how many times listings have been viewed by potential leads.
- Lead Attribution: : Integration to track the number of leads generated directly from specific listings.

Push Leads API Integration:We have collated a suite of Push APIs to streamline lead management.This update includes comprehensive documentation for payload and authentication protocols for following lead types:
- Call
- WhatsApp for Agent and Listing
- WhatsApp for TruBroker™ story

Wallets
- Wallet Balance : GET api/v1/users/{user}/wallets Added API to retrieve wallet balances by portal.
- VAS Products Pricing : GET api/v1/properties/{property_id}/pricing Added API to fetch applicable product pricing for a property.
- Consumption Logs : GET api/v1/consumptions Added API to retrieve consumption logs with filter support.

Location Search API
- Added ability to search locations by title with fuzzy matching for better results.
- Added support for filtering locations using location levels from level_1 to level_8.

The Publish Property API :
- (POST /api/v1/properties/{property_id}/products/attach) now supports posting to multiple portals (Bayut and Dubizzle) simultaneously when publishing a property.
- Portals Array Restriction: The portals array can only be used when publishing a property.
- Mutual Exclusivity: You cannot use both portal and portals fields in the same request
- Product Auto-Default: If product is not provided, it automatically defaults to publishing listing
Create Property API – User Identification :
- The Create Property endpoint now supports using user_email in place of user_id.
- Clients can now pass user_email to identify the user when creating a property.
- This removes the need to fetch or maintain the user ID beforehand.
- user_id is still supported and will continue to work as before.Clients may use either user_id or user_email.

Automatic publishing via the Create Property endpoint is now deprecated and no longer supported.

Property Publishing Behavior:Starting 1st December 2025, the Create Property endpoint will save properties in the draft state but will no longer publish them automatically.
To publish a property, use the Publish Property endpoint.Refer to the updated API documentation for guidance on creating draft listings and publishing them separately.

Update Agency Endpoint: Introduced PUT /agencies/{agency_id} for updating agency details, including Trade License information.
Agent Regulatory Compliance: Introduced /users/{user_id}/license/validate to validate an agent’s BRN and BLN license numbers.
Property Regulatory Compliance: Introduced /properties/{property_id}/permit/validate to validate the permit number of a property.

Super Admin Branch Access:Added support for hierarchical branch access.API consumers can now pass an agency_id in query parameters or request bodies of selected endpoints (e.g., users, properties) to retrieve data scoped to a specific branch.

Launched the Profolio API, providing:
- User and property creation
- Agency and user management
- Base regulatory features
- Core utility endpoints