Viewings

Create a viewing request

Creates a viewing request. Sandbox credentials use deterministic fixtures; live credentials create platform-attributed, side-effect-suppressed rows for public-safe platform listings. External URL: /v1/viewing-requests. Current Next.js implementation path: /api/platform/v1/viewing-requests. This mutating route requires Idempotency-Key and never sends SMS, WhatsApp, email, calendar writes, agent dispatch, or production webhooks in slice 1.

post/viewing-requests

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/viewing-requests
  • Auth: HTTP bearer

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

listing_idstring required

Sandbox fixture listing ID for sandbox credentials or public-safe platform listing ID for live credentials.

messagestring
consent_to_contacttrue required

Response

Viewing request accepted.

livemodeboolean required
idempotency_key_hashstring required
request_idstring required

Changes

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