---
title: "Revoke a valuation widget key"
method: POST
path: "/valuations/embed-keys/{embedKeyId}/revoke"
tags: ["Valuations"]
---

# Revoke a valuation widget key

`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

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.

## Path parameters

- `embedKeyId` string, uuid, required

## Headers

- `X-Correlation-Id` string
- `Idempotency-Key` string, required

## Request body

- ValuationEmbedKeyRevokeRequest
  - `reason` string

## Response `200`

The widget key, revoked or already revoked.

- ValuationEmbedKeyResponse
  - `embed_key` object, required
    - `id` string, uuid, required
    - `embed_key` string, required: The publishable key the widget script sends as `embed_key`.
    - `label` string, required
    - `allowed_origins` string[], required
    - `status` 'active' | 'revoked', required
    - `created_at` string, date-time, required
    - `revoked_at` string, date-time, nullable, required
  - `livemode` boolean, required
  - `request_id` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Missing or invalid platform API key.
- `403`: Credential, environment, or scope is not allowed.
- `404`: Platform API feature or resource is not available.
- `409`: Idempotency key is in progress or conflicts with an earlier request body.
- `429`: Rate limit exceeded.
- `500`: Unexpected platform API failure.
- `503`: A required managed platform dependency is unavailable.

---

[API](https://skmtc.dev/homejourney/apis/homejourney-platform-api.md) · [All operations](https://skmtc.dev/homejourney/apis/homejourney-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/homejourney/apis/homejourney-platform-api/revisions/a2c6fe063db1?raw)