---
title: "Create a Custom Field"
method: POST
path: "/customFields"
---

# Create a Custom Field

`POST /customFields`

## Headers

- `X-CAP-API-AUTH-KEY` string, required
- `X-CAP-API-AUTH-ORG-ID` string, required

## Request body

- object
  - `RAW_BODY` string

## Response `200`

200

- object
  - `entity` object[]
    - `orgId` integer
    - `name` string
    - `type` string
    - `dataType` string
    - `label` string
    - `scope` string
    - `defaultValue` string
    - `phase` string
    - `position` integer
    - `rule` string
    - `serverRule` string
    - `regex` string
    - `error` string
    - `isDisabled` integer
    - `isCompulsory` integer
    - `disableAtServer` integer
    - `isUpdatable` integer
    - `enableAuditTrail` integer
    - `isPiiData` integer
    - `isPsiData` integer
    - `helptext` string
    - `attrs` string
    - `value` string
  - `warnings` unknown[]
    - unknown
  - `errors` unknown[]
    - unknown
  - `success` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)