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

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

Servers

• https://{subdomain}.{domain}.com

Path parameters

How to start integrating

1. Add HTTP Task to your workflow definition.
2. Search for the API you want to integrate with and click on the name.
   • This loads the API reference documentation and prepares the Http request settings.
3. Click Test request to test run your request to the API and see the API's response.