---
title: "Create Custom Field"
method: POST
path: "/settings/custom_fields/new"
---

# Create Custom Field

`POST /settings/custom_fields/new`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/settings/custom_fields/new`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `module_name` 'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'MATERIAL_REQUESTS' | 'VENDOR' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM' | 'REQUEST' | 'PROJECT', required
  - `custom_field` object
    - `field_name` string, required
    - `group` string: Custom field group UID
    - `field_type` 'SINGLE_LINE' | 'MULTI_LINE' | 'SINGLE_ITEM' | 'RADIO' | 'MULTI_ITEM' | 'NUMBER' | 'DATE' | 'TIME' | 'DATETIME' | 'LOOKUP' | 'FILE' | 'MULTI_FILE' | 'VIDEO'
    - `field_description` string
    - `field_placeholder` string
    - `is_required` boolean
    - `field_validation` string: number/regex
    - `lookup_module` 'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'MATERIAL_REQUESTS' | 'VENDOR' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM': if field_type is LOOKUP
    - `regex_value` string: if field_validation is "regex"
    - `hide_to_fe` boolean
    - `hide_field` boolean
    - `read_only` boolean
    - `file_type` string
    - `max_value` string: if field_validation is "number"
    - `min_value` string: if field_validation is "number"
    - `default_option` boolean
    - `default_options` string[]
    - `is_dependent` boolean
    - `dependent_on` string
    - `dependent_options` string[]
    - `meta_options` object
      - `restrict_to_camera` boolean
      - `watermark_image` boolean

## Response `200`

200

- object
  - `type` string
  - `message` string
  - `data` object
    - `custom_field_uid` string

## Other responses

- `500`: 500

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/settings/custom_fields/new/post.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)