---
title: "Update User Field"
method: PUT
path: "/api/v2/user_fields/{user_field_id}"
tags: ["User Fields"]
---

# Update User Field

`PUT /api/v2/user_fields/{user_field_id}`

#### Updating a Dropdown (Tagger) or Multiselect Field

Dropdown and multiselect fields return an array of `custom_field_options` which specify the name, value, and order of the list of dropdown or multiselect options.
Understand the following behavior when updating a dropdown or multiselect field:

- All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations.
- To create a new option, pass a null `id` along with `name` and `value`.
- To update an existing option, pass its `id` along with `name` and `value`.
- To re-order an option, reposition it in the `custom_field_options` array relative to the other options.
- To remove an option, omit it from the list of options upon update.

#### Example Request

```bash
curl https://{subdomain}.zendesk.com/api/v2/user_fields/{user_field_id}.json \
  -H "Content-Type: application/json" -X PUT \
  -d '{"user_field": {"custom_field_options": [{"id": 124, "name": "Option 2", "value": "option_2"}, {"id": 123, "name": "Option 1", "value": "option_1"}, {"id": 125, "name": "Option 2", "value": "option_3"}]}}' \
  -v -u {email_address}/token:{api_token}
```
#### Allowed for

* Admins

## Response `200`

Success response

- UserFieldResponse
  - `user_field` UserFieldObject
    - `active` boolean — If true, this field is available for use
    - `created_at` string, date-time — The time of the last update of the ticket field
    - `custom_field_options` CustomFieldOptionObject[] — Required and presented for a custom field of type "dropdown". Each option is represented by an object with a `name` and `value` property
      - `id` integer — Automatically assigned upon creation
      - `name` string, required — Name of the dropdown option
      - `position` integer — Position of the dropdown option
      - `raw_name` string — Raw name of the dropdown option
      - `url` string — URL of the dropdown option
      - `value` string, required — Value of the dropdown option
    - `description` string — User-defined description of this field's purpose
    - `id` integer — Automatically assigned upon creation
    - `key` string, required — A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers
    - `position` integer — Ordering of the field relative to other fields
    - `raw_description` string — The dynamic content placeholder, if present, or the `description` value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `raw_title` string — The dynamic content placeholder, if present, or the `title` value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `regexp_for_validation` string, nullable — Regular expression field only. The validation pattern for a field value to be deemed valid
    - `relationship_filter` object — A filter definition that allows your autocomplete to filter down results
    - `relationship_target_type` string — A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", and "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment".
    - `system` boolean — If true, only active and position values of this field can be changed
    - `tag` string — Optional for custom field of type "checkbox"; not presented otherwise.
    - `title` string, required — The title of the custom field
    - `type` string, required — The custom field type: "checkbox", "date", "decimal", "dropdown", "integer", ["lookup"](/api-reference/ticketing/lookup_relationships/lookup_relationships/), "multiselect", "regexp", "text", or "textarea"
    - `updated_at` string, date-time — The time of the last update of the ticket field
    - `url` string — The URL for this resource

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)