Listing feed

Submit or update a feed listing

Submits a listing with its CEA salesperson and marketing authority when the authenticated client has listings.write. Every new listing and every change other than price, availability, last seen, expiry and unit count waits for a Homejourney reviewer, and the route answers 202; a published listing stays live meanwhile. Price and availability changes to a published listing apply at once and answer 200. A salesperson who is not current on the CEA register, or not registered under the agency licence, is refused with 422 before review. An organization may have 200 listings in review; beyond that the route answers 429 review_queue_full. Each status change sends listing_feed.status_changed. Live keys need listings.write and a live licensed estate agency organization with a feed source, created when live access is approved; otherwise the route answers 403 listing_feed_not_admitted. A sandbox key writes only sandbox storage: salesperson R000001A publishes, R000002B is rejected with photos_unclear, R000003C answers salesperson_not_under_agency, R000004D answers salesperson_not_current, and any other number stays in review. External URL: /v1/listing-feed/listings/{externalRef}. Current Next.js implementation path: /api/platform/v1/listing-feed/listings/[externalRef]. This mutating route requires Idempotency-Key.

put/listing-feed/listings/{externalRef}

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/listing-feed/listings/{externalRef}
  • Auth: HTTP bearer

Path parameters

externalRefstring required

The partner's own listing reference.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

titlestring
development_namestring
addressstring
unitstring
postal_codestring
districtstring
pricenumber
bedroomsinteger
bathroomsinteger
square_feetnumber
property_type'HDB' | 'Condominium' | 'Landed' | 'Commercial'
status'For Sale' | 'For Rent'
descriptionstring
imagesstring[]
latitudenumber
longitudenumber
available_fromstring date
furnishing_levelstring
tenurestring
built_yearinteger
lease_duration_monthsinteger
subletting_typestring
house_rulesstring[]
included_amenitiesstring[]
partner_availability_status'available' | 'limited' | 'unavailable'
partner_last_seen_atstring date-time
partner_expires_atstring date-time
available_units_countinteger
salesperson_registration_nostring required

Current on the CEA register and registered under the agency licence.

Response

A price or availability change applied to the published listing.

livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.