Skip to main content

Advertising API Documentation

Welcome to the Advertising API documentation.

Environments​

This documentation covers the Advertising API. You can test against different environments:

  • Production - Live production environment
  • Staging - Staging/testing environment

When viewing the API reference, use the Server dropdown in the API playground to switch between environments.

Important Information​

Please note the following key points when working with our system:

Custom IDs (thirdPartyId)​

  • All entities support the thirdPartyId field, allowing you to use your own custom IDs
  • You can filter entities by their thirdPartyId
  • Each thirdPartyId must be unique within its entity type, otherwise records will be overwritten

Required Fields​

  • Every ad must have an advertiser
  • Advertisers must have at least an email address for contact purposes
  • Companies must also have an email address

Photo Uploads​

  • Ads must be created first before you can upload photos

Ad Status Management​

Please use the status field on ads to indicate whether a property is:

  • Still for sale (open)
  • Reserved (reserved)
  • Sold (sold)
  • Withdrawn (inactive)

Important: Only use the delete endpoint when there was an error during creation or when a broker has requested complete removal from our portal. Do not delete ads simply because a property is no longer available.

We don't want to show clients that a property is newly listed when it isn't. Brokers often intentionally withdraw and recreate ads, and we're working to prevent this practice.

Getting Started​

Navigate to the API Reference section in the sidebar to:

  • Explore available API endpoints
  • View request/response schemas
  • Try out the API directly from this documentation