Valuations

Revoke a valuation widget key

Revokes one of the organization's widget keys when the authenticated client has valuations.embed_keys.write. Widgets using the key stop working within 60 seconds; revoking a revoked key returns it unchanged. External URL: /v1/valuations/embed-keys/{embedKeyId}/revoke. Current Next.js implementation path: /api/platform/v1/valuations/embed-keys/[embedKeyId]/revoke. This mutating route requires Idempotency-Key and records an audit event.

post/valuations/embed-keys/{embedKeyId}/revoke

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/valuations/embed-keys/{embedKeyId}/revoke
  • Auth: HTTP bearer

Path parameters

embedKeyIdstring uuid required

Widget key identifier.

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

reasonstring

Response

The widget key, revoked or already revoked.

livemodeboolean required
request_idstring required

Changes

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