---
title: "Manage Custom Fields"
slug: "omnichannel-custom-fields"
updated: 2026-05-28T01:21:52Z
published: 2026-05-28T01:21:52Z
canonical: "docs.rocket.chat/omnichannel-custom-fields"
excludeFromExternalSearch: true
---

> ## 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.

# Manage Custom Fields

Custom Fields in Omnichannel allow you to capture additional information about your visitors and their chat sessions, giving your team the detailed context needed to provide effective service.

You can use custom fields in two primary ways:

1. **Pre-chat registration**

Collect supplementary information from visitors during the Livechat registration process. This helps you gather data beyond the required fields in the [Livechat registration form](/v1/docs/livechat-widget-appearance#livechat-widget-registration-form).
2. **Defining additional properties**

Assign extra properties to either a visitor or livechat room:
  - **Visitor (Contact):** Set properties related to a visitor when [editing their contact profile](/v1/docs/omnichannel-contact-center#edit-omnichannel-contact-information).
  - **Room (Chat session):** Add more specific details to a chat room when [editing the room details](/v1/docs/omnichannel-conversations#room-information)**.**

---

## Access Omnichannel custom fields

To access the Custom Field menu:

- Navigate to **Manage** ![](https://cdn.us.document360.io/6ae79a05-7252-45d0-96e8-8f375e07b1b2/Images/Documentation/2025-11-03_11-59-50.png) **> Omnichannel > Custom Fields**.
- A list of all the existing custom fields is displayed.

---

## Create Omnichannel custom field

To add a new custom field:

1. Click the **Create custom field** button.
2. Fill in the following details:

| **Field** | Description |
| --- | --- |
| **Field** ***** | The internal name or key of the field (e.g., `account_type`). |
| **Label** ***** | The display name of the field displayed in the registration form. |
| **Scope** | Defines what the custom field property is associated with: - **Visitor**: Available as a property for the Omnichannel contact and displayed on the [contact information](/v1/docs/omnichannel-contact-center#view-omnichannel-contact-information). - **Room**: Available as a property for the specific Omnichannel room (chat session) and displayed on the [room information panel](/v1/docs/omnichannel-conversations#view-and-edit-room-information). |
| **Visible** | When enabled, the custom field is displayed in the contact’s details for agents. |
| **Searchable** | Allows searching in the [Omnichannel Contact Center](/v1/docs/omnichannel-contact-center) using the value of this custom field. |
| **Validation** | Use regular expressions to validate the format of the entered value. For example, entering `^[a-z]+$` ensures the field only accepts lowercase letters. > [!WARNING] > When a [manager](/v1/docs/omnichannel-users#omnichannel-managers) or [agent](/v1/docs/omnichannel-users#omnichannel-agents) sets a value in the workspace that doesn’t match the pattern, an error message appears, preventing the data from being saved. > > However, if a visitor enters invalid data through the [Livechat registration form](/v1/docs/livechat-widget-appearance#livechat-widget-registration-form), no error message is displayed. The chat is initiated successfully, but the custom field will not be registered. |
| ![](https://cdn.us.document360.io/6ae79a05-7252-45d0-96e8-8f375e07b1b2/Images/Documentation/Enterprise.svg) |
| **Required** | When enabled, this field is set as mandatory on the Livechat registration form. |
| **Type** | Select the input type for this field. - **Input**: Standard text entry field. - **Select**: Dropdown menu with pre-configured options. |
| **Default value** | Enter a default value for the field. |
| **Options** | If **Type** is set to **Select**, provide a comma-separated list of selectable values. Don’t add spaces between each option. |
| **Public** | If enabled, the custom field will be displayed in external applications, such as Livechat registration form. |

When a custom field is created, visitors can fill in its value through the [Livechat registration form](/v1/docs/livechat-widget-installation). The submitted values are then displayed to Livechat [agents](/v1/docs/omnichannel-users#omnichannel-agents).

---

## Edit Omnichannel custom field

To modify an existing custom field:

1. On the **Custom Fields** screen, click the custom field you want to edit.
2. A panel is displayed for you to edit the custom field details.
3. Click **Save** to apply your changes.

---

## Delete Omnichannel custom field

To delete a custom field:

1. On the **Custom Fields** screen, find the custom field you want to remove.
2. Click the **delete icon** ![](https://cdn.us.document360.io/6ae79a05-7252-45d0-96e8-8f375e07b1b2/Images/Documentation/image(161).png) on the right next to it.

> [!NOTE]
> Additionally, you can also set values for custom fields using the [Omnichannel API endpoints](https://developer.rocket.chat/apidocs/send-custom-field-value) or the [Livechat widget API](https://developer.rocket.chat/apidocs/livechatwidget-api).