Developer Documentation
Platform Overview
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Required Documents Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Required Documents Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Geometries Portals Portals: Listing Categories Portals: Metadata Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Terms of Use

Listings: Validation

This service validates a listing creation or update payload against listing rules defined for the listing's property type.

  1. Supported Roles
  2. Available Services
    1. Listing Creation Validation
    2. Listing Update Validation
  3. Listing History Description
  4. Expansions

Supported Roles

Role Reads Writes Notes
Public No No
Portal No No
Private No Yes

More information about roles may be found here.


Available Services

Listing Creation Validation

/<API Version>/listings/validation

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Validates a listing creation payload. No data is persisted. No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

POST Request

Request body:

   "D": {
      "PropertyType": "A",
      "PropertySubType": "SF",
      "ListPrice": 1079900,
      "StreetNumber": "611",
      "StreetDirPrefix": null,
      "StreetName": "8th",
      "StreetSuffix": "St",
      "StreetDirSuffix": "S",
      "StreetAdditionalInfo": null,
      "City": "Fargo",
      "StateOrProvince": "ND",
      "PostalCode": "58103",
      "YearBuilt": 1884,
      "BuildingAreaTotal": 7275,
      "BathsThreeQuarter": 1,
      "BathsTotal": 8,
      "BathsFull": 5,
      "BedsTotal": 8,
      "BathsHalf": 2,
      "Longitude": -96.792246,
      "Latitude": 46.868464,
      "SubdivisionName": "Westgate",
      "MLSAreaMinor": "West",
      "CountyOrParish": null,
      "ListAgentId": "20080917142739989238000000",
      "CustomFields": {
        "Contract Information": {
          "Book Section": "Residential w/ Acreage",
          "Area": "North (Bonner & Boundary)"

POST Response

The standard success/fail response with additional error information is returned.


Listing Update Validation

/<API Version>/listings/<Listing.Id>/validation

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Validates a listing update payload. No data is persisted. No
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

PUT Request

Request body:

   "D": {
      "ListPrice": 1080000

PUT Response

The standard success/fail response with additional error information is returned.


Listings: Validation Description

Available standard and custom fields will vary among users. Standard listing fields are discoverable using the Standard Fields service, and custom listing fields are advertised using the Custom Fields service.

Attribute Data Type Description
StandardFields Character All top-level attributes not otherwise documented here are standard listing fields.
CustomFields Character All custom listing fields must be provided as a hash of groups and their fields under the CustomFields attribute. Since these are not written to listings in order, these should not be presented in arrays as is returned by the listings service.