# Custom Fields

### Overview

Custom Fields are used to save or obtain additional information about your customers using different Field Types. You can access that information using the Contacts module or while interacting with them using Chat.

To open the Custom Fields option window, go to Contacts → Custom Fields from your Dashboard.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FqfFWSvZ9tpnOe7Qqw5M7%2FAccessing%20Custom%20Fields%20from%20Contacts.jpg?alt=media&#x26;token=768619ed-cef8-4de7-9df2-b17e14ddb134" alt=""><figcaption><p>Accessing Custom Fields from Contacts</p></figcaption></figure>

Or you can select Settings, then choose the Custom Fields tab.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FfhZCsLN6z0c76fKNov5N%2FAccessing%20Custom%20Fields%20from%20Settings.jpg?alt=media&#x26;token=f9c2d5e9-d38b-416d-84b4-3990250c665a" alt=""><figcaption><p>Accessing Custom Fields from Settings</p></figcaption></figure>

In both cases, you'll be able to access the Custom Fields options.

### Create a Custom Field

To create a Custom Field, you need to click the Create Custom Field button.&#x20;

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FENrElPlohbX5fdW0YEgq%2FCreating%20a%20Custom%20Field.png?alt=media&#x26;token=ee31f262-36a9-4ef4-9dfa-784f41a77b1a" alt=""><figcaption></figcaption></figure>

This will bring the Create Custom Field modal, where you get the following options:

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FSY661zTQa4fJteL77SvJ%2FCreate%20Custom%20Field%20Modal.png?alt=media&#x26;token=f9698e47-4ce3-4cfc-8db2-1048d23612d4" alt=""><figcaption></figcaption></figure>

* **Field Name** - Define the name of your custom field.
* **Field Type** - Select a custom field type from 6 different types that are,
  * Text(Single Line)
  * Text(Multi Line)
  * Email
  * Number
  * Date
  * Date Time
* **Priority** - To assign importance level to regard the field as more important than other custom fields. Numeric 1 is regarded as the top priority.
* **Search Allowed** - To search contacts based on Custom Field.
* **Show On Contacts Grid** - To showcase custom field details in the contacts module.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FKUplbmEN8hZBRJKZlaza%2FCustom%20Fields%20on%20Contacts%20Grid.png?alt=media&#x26;token=c9caa99c-77be-4017-afb3-11bf331164cf" alt=""><figcaption></figcaption></figure>

* **Is Required** - When creating the contact, adding value(s) to this field is necessary.&#x20;

Now, to create the custom field, first, input the Field Name, then select a Field Type.&#x20;

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FMcxKbwSn6oTdlUm7KeoO%2FDefining%20Custom%20Field%20Name%20and%20Type.png?alt=media&#x26;token=2e916e5c-350b-4d3f-9191-8e3e1fac5e42" alt=""><figcaption></figcaption></figure>

After selecting the field type, define Priority and check the tick box next to Search Allowed, Show On Contacts Grid, and Is Required if you want to apply those conditions on the field.&#x20;

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FyI4nCPQ8NhDaavl6dNJd%2FPriority%2C%20Conditions%20for%20Custom%20Field.png?alt=media&#x26;token=e374bab8-8f8c-4cff-b9c4-c445462915e3" alt=""><figcaption></figcaption></figure>

Once utilised all the options, click **Save** to create the Custom Field.&#x20;

### Edit a Custom Field

You'll find created custom fields in the Custom Fields window, Contacts → Custom Fields, like the following.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FJ9ofFOC73vBoG2TdXF2g%2FEditing%20a%20custom%20field.png?alt=media&#x26;token=532c63f8-f203-4030-9e77-60e02ef4ec09" alt=""><figcaption></figcaption></figure>

To edit a custom field, click on the Pen/Edit Icon. &#x20;

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fdbu4pXAA81aVsRCzO9iF%2FSaving%20Changes%20to%20Custom%20Field.png?alt=media&#x26;token=c3346219-5824-48b1-bfa1-13897dbf562e" alt=""><figcaption></figcaption></figure>

Simply make the changes, and once edited, click **Update**.

### Delete a Custom Field

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FAiz84i72RdN6GzaXc7hU%2FDeleting%20a%20Custom%20Field.png?alt=media&#x26;token=4f19c8c0-a5a6-429c-a1b4-12a861cba805" alt=""><figcaption></figcaption></figure>

Locate your custom field by going to the Contacts → Custom Fields.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fm3J68BHZG1YhjEW6B94e%2FConfirming%20the%20Custom%20Field%20Delete.png?alt=media&#x26;token=f2640fcb-a311-4d4c-a1c5-07dd592da0a8" alt=""><figcaption></figcaption></figure>

Then, click on the Trash icon and further click **Confirm**.

### Use

To utilise a particular Custom Field, you can access the Contacts module and, from there, edit the contact. Then, scroll down to find the custom field(s).

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2F3Kopuhmq4Mnnq5OcQvCZ%2FAccessing%20Custom%20Field%20to%20Add%20Info%20from%20Contacts.png?alt=media&#x26;token=942463b1-5951-43d3-9649-928b80a66248" alt=""><figcaption></figcaption></figure>

Once added or edited the information, you can click **Save**.

#### Access Custom Fields Using Chat

Another method to access custom fields is when you're chatting with the contact.

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fs360AzEsbLTpac75jIIp%2FAccessing%20Custom%20Field%20to%20Add%20Info%20from%20Chat.png?alt=media&#x26;token=cfd78c52-b52a-45ad-be8a-abbcc2b8e73d" alt=""><figcaption></figcaption></figure>

Click on the contact's name, then click the Edit icon. This will open the Edit Contact modal. Scroll down to find the custom fields to add the information or edit it&#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rampwin.com/english/custom-fields-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
