Update User Field

PUT {{baseUrl}}/api/v2/user_fields/:user_field_id

Updating a Dropdown (Tagger) Field

Dropdown fields return an array of custom_field_options which specify the name, value and order of the list of dropdown options. Understand the following behavior when updating a dropdown 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

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}:{password}

Allowed for

• Admins

HEADERS

RESPONSES

status: OK

{"user_field":{"active":true,"created_at":"2013-02-27T20:35:55Z","description":"This field describes the support plan this user has","id":75,"key":"support_description","position":0,"raw_description":"This field describes the support plan this user has","raw_title":"Support description","regexp_for_validation":null,"title":"Support description","type":"text","updated_at":"2013-02-27T20:35:55Z","url":"https://company.zendesk.com/api/v2/user_fields/75.json"}}