--- title: "Configure Custom Fields in Rocket Chat" slug: "custom-fields" description: "Learn how to create and manage custom fields. Enable secure data handling and tailored collaboration." status: "update" updated: 2026-11-19T01:51:30Z published: 2026-11-19T01:51:30Z canonical: "docs.rocket.chat/custom-fields" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.rocket.chat/llms.txt > Use this file to discover all available pages before exploring further. # Configure Custom Fields for Users You can set custom fields for specific users while registering or updating user information. For example, you can add fields like address or employee ID. > [!NOTE] > To define fields other than those in the examples, you need a basic understanding of JSON and how Rocket.Chat stores user data. ## Define custom fields To set custom fields, go to **Manage → Workspace → Settings → Accounts → Registration → Custom Fields**. Configure the custom fields using a [JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) containing a dictionary of field settings. The setting provides a code editor with line numbers. Click **Full Screen** to expand the editor while working with larger configurations. **Basic example** This example adds two custom fields, `team` and `designation`, with the type `text`. This means that the custom fields can take any text values as input. ```json { "team": { "type": "text" }, "designation": { "type": "text" } } ``` > [!WARNING] > Custom field keys are case-sensitive. The key you define here (for example, `team`) is the exact name you must use everywhere the field is referenced, such as in **Custom Fields to Show in User Info** or via the API. After you save the custom fields, they appear when you create a new user or update an existing one, as shown in the following screenshot: ![Custom fields team and designation in the user form](https://cdn.us.document360.io/6ae79a05-7252-45d0-96e8-8f375e07b1b2/Images/Documentation/image(43).png) **Advanced example** Here, `role` is a custom field consisting of two options (`teacher` and `student`) as the possible values. `twitter` and `dept` are text fields where you can enter values according to the defined settings. ```json { "role": { "type": "select", "defaultValue": "student", "options": ["teacher", "student"], "required": true, "modifyRecordField": { "array": true, "field": "roles" } }, "twitter": { "type": "text", "required": true, "minLength": 2, "maxLength": 10 }, "dept": { "type": "text", "required": false, "minLength": 12, "sendToIntegrations": true } } ``` The following table describes each property: | Parameter | Description | | --- | --- | | **type** | Defines the type of the custom field. There are two types: `select` and `text`, where `select` creates a drop-down list, and `text` creates a plain text form. If you enter a URL in the text field, it is interpreted as a hyperlink (it will be clickable on the **User Info** pane). | | **defaultValue** | Used with a `select` form type to set the default option for the list. | | **options** | Used with a `select` form type for the values that should be on the drop-down list, which follows the `["item1", "item2","item3"]` pattern. Use a [JavaScript Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) to create it. | | **required** | Set whether the field is required for registration. Enter `true` or `false` for this property. | | **minLength** | Used with the `text` type to define the minimum length required for the text. | | **maxLength** | Used with the `text` type to define the maximum length allowed for the text. | | **modifyRecordField** | This property is required when you add a field that already exists in Rocket.Chat. > [!WARNING] > The `modifyRecordField` property allows users to modify the mapped field on their own profile. If pointed at sensitive fields like `roles` or `permissions`, regular users can escalate their own privileges, including granting themselves administrator access. Review this configuration carefully and avoid mapping to security-sensitive fields unless you fully understand the implications. | | **array** | Used inside the `modifyRecordField` property to define whether the existing field is an array. | | **field** | Used inside the `modifyRecordField` property. It must be the exact (case-sensitive) name of the existing field, for example `roles`. | | **public** | Defines the field as visible to other users when viewing the user's profile. Enter `true` or `false` for this property. By default, the value is `true`. | | **private** | Defines the field as private. Only users with `view-full-other-user-info` permission can see this field when viewing the user's profile. Enter `true` or `false` for this property. | | **sendToIntegrations** | Defines the field as shareable with external applications, such as Omnichannel integrations. | > [!NOTE] > - Use tabs for indentation in the JSON object, do not use spaces. > - You can also use the API to create and manage custom fields. See the [Create User](https://developer.rocket.chat/apidocs/create-user), [Update User](https://developer.rocket.chat/apidocs/update-user), and [Get Users List](https://developer.rocket.chat/apidocs/get-users-list) endpoints. ## Display user’s custom fields You can configure the list of custom fields displayed on the **User Info** panel. Go to **Manage → Workspace → Settings → Accounts → Custom Fields to Show in User Info**. The value must be a JSON array of objects, where each object's **key is the label** shown to users and its **value is the custom field name** defined previously: ```json [{"label1":"key1"},{"label2":"key2"},...] ``` The label can be the name of the custom field that is displayed for users. The key must be a custom field name defined previously. Based on the advanced example, the field can look like this: ```json [{"Role":"role"},{"Department":"dept"}] ``` This means that the `role` and `dept` custom fields are displayed on the **User Info** panel with the labels **Role** and **Department**. A field is shown only if it is set to `"public": true` or if the viewer has permission to view private fields. ## Set custom field values To enter values for the custom fields, create a new user or edit an existing one, fill in the fields, and save. For instructions, see [Manage Workspace Users](/v1/docs/manage-workspace-users). ## Next steps To set rules for message editing, deleting, and link previews, see [Message Settings](/v1/docs/message).