---
title: "Replace Widget Settings"
method: PUT
path: "/v1/widgets/settings"
tags: ["Widgets"]
---

# Replace Widget Settings

`PUT /v1/widgets/settings`

## Request

- Base URL: `https://api.sandbox.usenash.com`
- URL: `https://api.sandbox.usenash.com/v1/widgets/settings`
- Auth: none declared

Replace the org's widget settings. Origins are normalized to `scheme://host[:port]`; an omitted field clears it.

## Request body

- WidgetSettingsWrite: Request body for a settings write. Deliberately `extra="forbid"`, unlike the stored `WidgetSettings` model (which allows extras so it can round-trip keys written by the legacy `updateOrganizationPreferences` path). A REST client sending an unknown key is making a mistake, and silently persisting it into an authorization- bearing blob is the wrong way to find out.
  - `allowed_origins` string[]: Exact parent origins (scheme + host + port, no trailing slash, no wildcards).
  - `widgets` WidgetEnablement[]
    - `widget` 'nash_agent' | 'live_map' | 'eta_chip' | 'delivery_list' | 'delivery_details', required: The widgets the platform can mint an Embed Session for. Values are stable wire identifiers: they key the storage map and are sent as `widget` when minting. Adding a member is additive; renaming one is a breaking change to stored org config and must be migrated.
    - `enabled` boolean

## Response `200`

OK

- WidgetSettingsResponse
  - `allowed_origins` string[], required
  - `widgets` WidgetEnablement[], required
    - `widget` 'nash_agent' | 'live_map' | 'eta_chip' | 'delivery_list' | 'delivery_details', required: The widgets the platform can mint an Embed Session for. Values are stable wire identifiers: they key the storage map and are sent as `widget` when minting. Adding a member is additive; renaming one is a breaking change to stored org config and must be migrated.
    - `enabled` boolean

## Other responses

- `422`: Unprocessable Content

---

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