> ## Documentation Index
> Fetch the complete documentation index at: https://docs.play2sell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Fields

> Add custom fields to leads and deals to capture data specific to your business.

# Custom Fields

Custom fields let you extend the default SalesOS data model with fields specific to your business. Add them to leads, deals, or both to capture the information your team needs.

## Creating a Custom Field

<Steps>
  <Step title="Go to Admin > Custom Fields">
    Open the Admin panel and click **Custom Fields**.
  </Step>

  <Step title="Select the entity">
    Choose whether the field applies to **Leads**, **Deals**, or **Both**.
  </Step>

  <Step title="Click Add Field">
    Click the **+ Add Field** button.
  </Step>

  <Step title="Configure the field">
    Set the field properties:

    * **Label** — The display name shown to users
    * **Field key** — A unique identifier (auto-generated from the label, used in the API)
    * **Type** — The data type (see field types below)
    * **Required** — Whether the field must be filled in
    * **Default value** — An optional pre-filled value
    * **Description** — Help text shown below the field
  </Step>

  <Step title="Save">
    Click **Create Field**. The field is immediately available on all new and existing records.
  </Step>
</Steps>

## Field Types

| Type             | Description                             | Example                           |
| ---------------- | --------------------------------------- | --------------------------------- |
| **Text**         | Single-line text input                  | Company website, reference number |
| **Long Text**    | Multi-line text area                    | Detailed notes, requirements      |
| **Number**       | Numeric input (integers or decimals)    | Employee count, budget amount     |
| **Currency**     | Formatted currency value                | Expected annual revenue           |
| **Date**         | Date picker                             | Contract start date, renewal date |
| **Dropdown**     | Single selection from a list of options | Industry, lead source, deal type  |
| **Multi-Select** | Multiple selections from a list         | Product interests, pain points    |
| **Checkbox**     | Boolean true/false                      | Has NDA signed, is key account    |
| **Email**        | Email address with validation           | Secondary contact email           |
| **Phone**        | Phone number with formatting            | Alternative phone number          |
| **URL**          | Web address with validation             | Company LinkedIn profile          |

## Managing Field Options

For **Dropdown** and **Multi-Select** fields, you need to define the available options:

1. Open the field settings
2. Click **Manage Options**
3. Add options one at a time, or paste a list
4. Drag to reorder options
5. Set a default selection (optional)
6. Save

<Tip>
  Keep dropdown options concise and consistent. Use "Information Technology" instead of mixing "IT", "Info Tech", and "Information Technology" as separate options.
</Tip>

## Field Ordering and Grouping

Control how custom fields appear on the record form:

* **Drag and drop** fields to reorder them
* **Create sections** to group related fields together
* **Set column layout** — Display fields in 1 or 2 columns

### Field Sections

Group related fields under named sections:

1. Click **Add Section** above the field list
2. Name the section (e.g., "Company Details", "Technical Requirements")
3. Drag fields into the section

## Required Fields by Stage

You can make fields required only when a deal reaches a specific pipeline stage:

1. Edit the custom field
2. Under **Conditional Requirements**, click **Add Rule**
3. Select the stage where this field becomes required
4. Save

Example: Make "Contract Value" required when a deal enters the "Proposal" stage, and "Loss Reason" required when moving to "Closed Lost".

<Note>
  Stage-conditional required fields prevent deals from moving to the next stage until the field is filled. This ensures data quality at critical points in the sales process.
</Note>

## Using Custom Fields in Filters and Reports

Custom fields are available in:

* **Pipeline filters** — Filter deals by any custom field value
* **Lead list filters** — Filter leads by custom field values
* **Reports** — Group and aggregate data by custom field values
* **Export** — Custom fields are included in CSV exports
* **API** — Custom fields are accessible via the API

## Editing and Deleting Fields

### Editing

You can edit a field's label, description, required status, and default value at any time. Changing the field type after creation is not supported — create a new field if you need a different type.

### Deleting

<Warning>
  Deleting a custom field permanently removes it and all its data from every record. This action cannot be undone. Export your data before deleting if you need to preserve the information.
</Warning>

To delete a field:

1. Go to **Admin > Custom Fields**
2. Click the field you want to remove
3. Click **Delete Field**
4. Type the field name to confirm
5. Click **Permanently Delete**

## Next Steps

<CardGroup cols={2}>
  <Card title="Workflows" icon="bolt" href="/admin/customization/workflows">
    Automate actions based on field values
  </Card>

  <Card title="Pipeline" icon="columns-3" href="/user-guide/sales/pipeline">
    See custom fields in action on deals
  </Card>
</CardGroup>