---
title: "Edit Choice Catalog"
method: PUT
path: "/knowledge/choice-lists/{reference}"
tags: ["knowledge"]
---

# Edit Choice Catalog

`PUT /knowledge/choice-lists/{reference}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/knowledge/choice-lists/{reference}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `reference` string, required

## Headers

- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable
- `organization-id` string, nullable

## Request body

- ApproveChoiceEdit
  - `expected_revision` string, required
  - `scope` 'core' | 'shop', required
  - `change` union, required
    - UpdateChoiceList
      - `kind` 'list', required
      - `label` string, required
      - `shop_permissions` ShopChoicePermissions, required
        - `add_items` boolean
        - `hide_items` boolean
        - `relabel_items` boolean
        - `add_synonyms` boolean
    - PutChoiceItem
      - `kind` 'item', required
      - `key` string, required
      - `label` string, required
      - `synonyms` string[]
      - `parent_key` string, nullable
      - `sort_order` integer
      - `retired` boolean
      - `shared_vocabulary` boolean
    - PutChoiceOverride
      - `kind` 'override', required
      - `key` string, required
      - `label` string, nullable
      - `synonyms` string[]
      - `hidden` boolean

## Response `200`

Successful Response

- ChoiceCatalogResponse
  - `id` string, required
  - `key` string, required
  - `label` string, required
  - `organization_id` string, nullable, required
  - `shop_permissions` ShopChoicePermissions, required
    - `add_items` boolean
    - `hide_items` boolean
    - `relabel_items` boolean
    - `add_synonyms` boolean
  - `revision` string, required
  - `items` ChoiceOption[], required
    - `id` string, required
    - `key` string, required
    - `label` string, required
    - `synonyms` string[]
    - `parent_key` string, nullable
    - `ancestor_keys` string[]
    - `hidden` boolean
    - `retired` boolean
    - `organization_id` string, nullable

## Other responses

- `422`: Validation Error

---

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