---
title: "Update User Preference Definition"
method: PUT
path: "/admin/user-preferences/definitions/{definition_id}"
tags: ["admin", "user-preferences"]
---

# Update User Preference Definition

`PUT /admin/user-preferences/definitions/{definition_id}`

## 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/admin/user-preferences/definitions/{definition_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `definition_id` string, required

## Headers

- `organization-id` string, nullable
- `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

## Request body

- UserPreferenceDefinitionUpdate
  - `label` string, nullable
  - `description` union
    - string
    - 'UNSET': Sentinel to distinguish 'not provided' from 'explicitly set to None'.
  - `category` 'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general'
  - `default_value` union
    - string
    - integer
    - number
    - boolean
    - string[]
    - integer[]
    - object
    - unknown[]
      - unknown
    - 'UNSET': Sentinel to distinguish 'not provided' from 'explicitly set to None'.
  - `validation_schema` union
    - object
    - 'UNSET': Sentinel to distinguish 'not provided' from 'explicitly set to None'.
  - `is_org_scoped` boolean, nullable
  - `sort_order` integer, nullable

## Response `200`

Successful Response

- UserPreferenceDefinitionResponse
  - `id` string, required
  - `key` string, required
  - `label` string, required
  - `description` string, nullable, required
  - `category` 'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general', required
  - `value_type` 'string' | 'integer' | 'float' | 'boolean' | 'string_list' | 'integer_list' | 'json', required
  - `default_value` union, required
    - string
    - integer
    - number
    - boolean
    - string[]
    - integer[]
    - object
    - unknown[]
      - unknown
  - `validation_schema` object, nullable, required
  - `is_org_scoped` boolean, required
  - `sort_order` integer, required

## 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/86e2c2bd93af?raw)