![Available on all Suite plans](https://zen-marketing-documentation.s3.amazonaws.com/docs/en/plan_available_suite_all.png)
![Available on all Support plans](https://zen-marketing-documentation.s3.amazonaws.com/docs/en/plan_available_all.png)
Admins and agents in custom roles with permissions can create numerous types of custom user fields and add them to user profiles to store additional customer details. Custom user fields are visible to all agents and are editable by agents with access to all tickets. End users cannot see or edit custom user fields. Any custom user fields you create apply to all users.
Creating custom user fields
Administrators and agents in custom roles with permission can create any custom field type for a user, except credit card.
- In Admin Center, click
People in the sidebar, then select Configuration > User fields.
- Click Add field.
- Select a field type, then enter a Display name. Multi-select fields are not available for custom user fields.
- Verify that the field key is the value you want it to be.
A field key enables the custom field to be referenced in placeholders and the API. When you enter a name for the field, the field key is automatically populated. If you want the name and key to be different, you must edit the field key. You can't change the field key after you create the custom user field.
Avoid field keys that overlap with system fields, such as id, name, tags, details, and notes.
- (Optional) Add a Description for the custom field. This is visible to admins only.
- Set other properties for your field. Options vary depending on the type of field you
are adding.
-
Field option (checkbox fields only, optional):
Enter a tag to apply to a ticket when the checkbox is selected.
-
Field validation (regex fields only):
Enter a regular expression to create an input mask to validate entry.
-
Field values (drop-down and multi-select fields):
- Enter Field options to include in the list. Click the X to remove a
value.
You can bulk import field values if you have a large number to add.
- Click Sort ascending or use the drag-and-drop icon
(
) to manually reorder the field values.
- To create a nested drop-down list, separate categories and values with a double colon (::). See Organizing drop-down lists.
- Enter Field options to include in the list. Click the X to remove a
value.
-
Related object and Set a filter (lookup relationship fields
only)
Select the type of object to relate, and optionally define filters that restrict possible values for the field. See Adding lookup relationship fields.
-
Field option (checkbox fields only, optional):
- Click Save or, to create another custom field, click the drop-down icon and
select Save and add another.
New fields are active by default and are added to all users.
- If needed, you can reorder your custom user fields.
Cloning custom user fields
Administrators and agents in custom roles with permission can create new custom fields from scratch or clone existing user fields and modify them as needed.
- In Admin Center, click
People in the sidebar, then select Configuration > User fields.
- Hover over the row of the user field you want to clone, then click the option menu
icon (
) and select Clone.
A detailed view of the user field's settings is displayed.
- Edit the Display name and Field key so that they are unique.
The field key is populated by the field name, but you can edit it when creating the custom field. You can't change the field key after the custom field is created. The field key can be used to reference the custom field in placeholders and the API.
- Set any other options for your field, depending on the type.
- Click Save.
New user fields are active by default and are added to all organizations.
- If needed, you can reorder your custom user fields.
67 comments
Arianne Batiles
Hi Jahn,
Custom user fields can now be shown in the user data app. You need to click on the Settings (gear icon) and select the user fields you want to display in the app.
1
Jahn
Thank you @Arianne Batiles
0
Mgo Dono
Is there a way to create a ticket field and sync the user fields into the ticket section?
0
Mehmet KIZILASLAN
ticket field Where should I create it?
0
Brett Elliott
Hi Mgo Dono,
Not natively in Zendesk. I have seen some Zendesk customers achieve user <> ticket field syncing with custom scripts that use our public APIs.
If you don't mind me asking, what are you trying to achieve by syncing user and ticket fields?
0
Federico
Hi! I'd like to implement something like this: since the service I'm selling is age and location specific, I want to ask the prospect customers to input also their DoB and ZIP code when submitting a request. I managed to add the custom fields to the tickets. Is there a way to update the customer values automatically once the ticket is opened? Alternatively, can I just feed the user info to the user without going through the ticket fields? Thank you in advance
0
Dane
It's possible by utilizing Update APIs, Webhooks and Triggers.
First is to create your webhook using the user update API.
This will be the endpoint that you will use.
The next step is to create the trigger that will utilize the webhook above. I have used these conditions to serve as your reference.
This is the action.
Please take note of the values inside the red and green box.
"test_user_field": This is the Field Key found on the custom user field.
"": This is the placeholder for the custom ticket field that you have created.
You can freely add addition fields here like DoB and Location.
Once done, it should automatically update the user field value depending on the corresponding ticket field value each time a ticket is created.
0
Federico
Thanks, Dane!
0
Phil Capezio
Trying to accomplish the same thing, and I'm using all of the exact same settings, but not having any luck. In my use case, I'm trying to take the customer's city from a custom ticket field and add it to their profile with a custom user field. Both fields are text fields for reference. What am I missing? Thanks in advance.
![](/hc/user_images/c5V3qEtm5r_Ohs_R7IWA3w.png)
0
Zsa Trias
Hello Phil,
It seems that you have created a trigger to run the webhook and populate the user field per Dane's solution above.
I would suggest checking the events of the ticket first to confirm if the trigger had run.
It must be that the conditions of the trigger weren't met which could be the reason why the webhook didn't apply the update.
0
Phil Capezio
Caught the mistake.
It's user_fields and not userfields
0
Zsa Trias
Awesome! Thanks for sharing! :)
0
Hayley Johnson
Is it possible to customise the view for users based on brand? We have an integration that is pulling user ID's and other user information from different places for 2 different brands. Currently all fields show on the user page which looks messy. It would be good if we could only show the user fields relevant to the brand associated with that user?
0
Jahn
Hayley Johnson - I guess best to have 2 different ticket forms if you need different ticket fields per brand.
0
Andres
What user fields are not custom, I'm assuming name, email and phone come out of the box, but is there a way to see what the default user fields are? I can only find my custom user fields.
0
Noly Maron Unson
Hi Andres,
The default user fields are the ones natively found in your user profile details. You can check Viewing and editing your user profile in Zendesk Support and it should be under About your user profile details. Everything else is a custom user field.
Hope this helps.
1
Andres
Thank you Noly Maron Unson - that's exactly what I was looking!
0
Michael Le
Hello I hope all is well, I'm having difficulties translating Custom Fields into Custom User Fields with a webhook as shown above with Dane's example, may I have someone take a look and see why the webhook is not firing nor trigger?
We're trying to have a text custom Custom Field translate into a text custom User Profile Field via a webhook as we're unable to do so with triggers.
Note the webhook originally gave me a 200 Okay response, but when I went in to take this snippet it came back as 404 Not Found.
Thank you in advance.
0
Brandon (729)
Hey Michael Le -
Your config looks sound - you might want to make sure you're using a valid requester.id in your test (or create a test ticket and see if it returns a different response). Also, if your test data has commas in it, that might be throwing off the json.
Cheers,
Brandon
0
Denis Iliev
Hello! We are currently using a custom field categorized as "text" instead of "email" within the user data input section. However, we have noticed that this element doesn’t provide clarity to our users regarding its purpose. Instead, it might confuse them about the requirements for entering an email address, which is intended for feedback purposes.
We would like to edit or add clarification to this built-in "Email" field to make its purpose clearer for our users. Is it possible to perform this edit? We aim to introduce explanatory text alongside the field, guiding users on what is expected when filling in their email addresses.![](/hc/user_images/01HKCGN6JTQ4MR698KE6W2N6E5.jpeg)
![](/hc/user_images/01HKCGN6G0B6DRJ9PWTPZTG68F.png)
0
Mike DR
As of now there isn't a way to edit the title of the ticket field or add a note on the field
0
Denis Iliev
Thank you for your response. I would like to inquire if there is a method to create a custom field that functions similarly to the system-provided "Email" field, specifically intended for feedback purposes. The objective is to restrict entries within this custom field to be exclusively in the format of an email address (e.g., example@site.com) and disallow any other text input.
0
Mike DR
You're most welcome! For your use case, I would suggest the Ruby Regular Expression (Regex) custom ticket field. However, it's currently not yet available to be used in the bot builder.
1
Anna C
We have customer attributes that are managed in an external system, and we want to display them in the support view for our agents. It appears that custom fields is the way to do this, but we don't want agents editing this data in Zendesk. Is there a way to make custom fields read-only? Or is there a different way to achieve this?
0
ish
Hey guys, I have been looking for guides to help me with adding fields in a bot. As you can see, I added fields under "Objects and rules > Tickets > Fields", but there are only two visible fields: name and email.
Any assistance will be highly appreciated.
Thanks in advance
0
Frédéric
It has just been announced that Zendesk discontinue the app TAG LOCKER and recommend to Use custom fields to restrict agents from creating or populating tags independently.
I don't seem to find any information how custom field can restrict agent to create tags.
Anyone has a suggestion and someone at zendesk can help?
Thanks
1
Greg S.
I came here with the exact same question as Frédéric. The core purpose Tag Locker has for our business is to hide the native Tag field from agents entirely. We already use numerous Custom Fields to fill in tags as appropriate, but being unable to hide the native field means agents will be able to add whatever tags they want to the case which will cause issue with some of our metrics.
I'd like to know how we will still be able to restrict our agents from adding whatever tags they would like once the TAG LOCKER app has been disabled.
0
Brandon (729)
Hey Frédéric & Greg S -
Another built-by-Zendesk option available to you for the purpose of restricting or hiding tags is the free Ticket Field Manager App, which has the ability to hide the tag field from the agent view.
Hope this helps!
Brandon
1
Frédéric
Brandon (729) thank you for your feedback, however, this is not what I'm looking for.
The main purpose of tag locker was to block creation of tag by agent, as well, giving possibilities to select tag in a defined list.
This was to give consistency in tags used, it's not only about hiding the tag field.
How can we prevent agent adding any random tag and provide a list of tag they can select, similar to how TAG LOCKER was working?
0
Brandon (729)
Hey Frédéric -
You are correct - hiding the Tag field only prevents rogue tags from being added. For consistent tag application, the best practice is to create a custom drop-down field wherein the values are agent-friendly versions of the tags, and the tags are the desired picklist of tags, ie:
Value | Tag
Silver | silver_sponsor
Gold | gold_sponsor
Platinum | platinum_sponsor
In Explore, you can still report on the tags even if the Agent is selecting from the custom field.
Hope this helps!
Brandon
0