---
title: "Create a new custom field"
method: POST
path: "/v2/custom-fields"
tags: ["Custom Fields"]
---

# Create a new custom field

`POST /v2/custom-fields`

Creates a new custom field (node attribute) with the specified configuration

## Request body

- object
  - `label` string, required — Display label for the custom field
  - `fieldName` string, required — Unique field name for API access (used when accessing the value programmatically)
  - `description` string — Description of the custom field
  - `type` 'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' — The type of custom field that determines how data is stored and displayed
  - `technicianPermission` 'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED' — Technician access level for custom fields
  - `scriptPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Script access level for custom fields via automation
  - `apiPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)
  - `defaultValue` string — Default value for the custom field. This only has an effect for DROPDOWN and MULTI_SELECT attributes
  - `content` object — Content configuration for the custom field
    - `values` object[] — List of predefined values for dropdown/radio types
      - `name` string — Display name for the option
    - `required` boolean — Whether the field is required
    - `footerText` string — Footer text displayed below the field
    - `tooltipText` string — Tooltip text for the field
    - `advancedSettings` object
      - `fileMaxSize` integer
      - `fileExtensions` string[]
      - `dateFilters` object
        - `type` 'NONE' | 'INCLUDE' | 'EXCLUDE' | 'PAST_DATES_ONLY' | 'FUTURE_DATES_ONLY' | 'RANGE' — Date filtering options for date/time custom fields
        - `selected` string[]
      - `maxCharacters` integer
      - `complexityRules` object
        - `mustContainOneInteger` boolean
        - `mustContainOneLowercaseLetter` boolean
        - `mustContainOneUppercaseLetter` boolean
        - `greaterOrEqualThanSixCharacters` boolean
      - `numericRange` object
        - `min` number
        - `max` number
      - `org` integer[]
      - `nodeClass` string[]
      - `ipAddressType` 'ALL' | 'IPV4' | 'IPV6' — IP address validation type for IP address custom fields
      - `expandLargeValueOnRender` boolean
      - `identifier` object
        - `automaticGenerationEnabled` boolean
        - `scope` 'NONE' | 'GLOBAL' | 'ORGANIZATION'
        - `assignTo` 'NEW_ASSETS_ONLY' | 'NEW_AND_EXISTING_ASSETS'
        - `type` 'CUSTOM' | 'SEQUENCE'
        - `nextSequenceNumber` integer
        - `prefix` string
        - `suffix` string
      - `monetary` object
        - `currency` 'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG'
      - `templates` integer[]
      - `nodeRole` integer[]
  - `scope` 'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS' — Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)
  - `definitionScope` string[] — Definition scope for the custom field
  - `groupId` integer — Group ID for organizing custom fields
  - `addToDefaultTab` boolean — Whether to add to the default tab

## Response `200`

Custom field created successfully

- object
  - `entityType` 'USER' | 'NODE' | 'TICKET' | 'DOCUMENT' — Entity type that this custom field or operation applies to
  - `scope` 'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS' — Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)
  - `definitionScope` string[] — Definition Scope
  - `type` 'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' — The type of custom field that determines how data is stored and displayed
  - `label` string — Label
  - `description` string — Description
  - `name` string — Name
  - `defaultValue` string — Default Value
  - `endUserPermission` 'HIDDEN' | 'EDITABLE_OPTIONAL' | 'EDITABLE_REQUIRED' | 'READ_ONLY' — End user access level for custom fields in the UI
  - `technicianPermission` 'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED' — Technician access level for custom fields
  - `scriptPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Script access level for custom fields via automation
  - `apiPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)
  - `content` object
    - `customizeForEndUser` boolean
    - `endUserCustomization` object
      - `name` string
      - `description` string
      - `label` string
    - `values` object[]
      - `id` string, uuid
      - `name` string
      - `active` boolean
      - `system` boolean
    - `required` boolean
    - `footerText` string
    - `tooltipText` string
    - `advancedSettings` object
      - `fileMaxSize` integer
      - `fileExtensions` string[]
      - `dateFilters` object
        - `type` 'NONE' | 'INCLUDE' | 'EXCLUDE' | 'PAST_DATES_ONLY' | 'FUTURE_DATES_ONLY' | 'RANGE' — Date filtering options for date/time custom fields
        - `selected` string[]
      - `maxCharacters` integer
      - `complexityRules` object
        - `mustContainOneInteger` boolean
        - `mustContainOneLowercaseLetter` boolean
        - `mustContainOneUppercaseLetter` boolean
        - `greaterOrEqualThanSixCharacters` boolean
      - `numericRange` object
        - `min` number
        - `max` number
      - `org` integer[]
      - `nodeClass` string[]
      - `ipAddressType` 'ALL' | 'IPV4' | 'IPV6' — IP address validation type for IP address custom fields
      - `expandLargeValueOnRender` boolean
      - `identifier` object
        - `automaticGenerationEnabled` boolean
        - `scope` 'NONE' | 'GLOBAL' | 'ORGANIZATION'
        - `assignTo` 'NEW_ASSETS_ONLY' | 'NEW_AND_EXISTING_ASSETS'
        - `type` 'CUSTOM' | 'SEQUENCE'
        - `nextSequenceNumber` integer
        - `prefix` string
        - `suffix` string
      - `monetary` object
        - `currency` 'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG'
      - `templates` integer[]
      - `nodeRole` integer[]
  - `system` boolean — System
  - `active` boolean — Active
  - `createTime` number, double — Create Time
  - `updateTime` number, double — Update Time

## Other responses

- `400` — Invalid request data

---

[API](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0.md) · [All operations](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjarmm/ninjaone-public-api-2-0/revisions/753f26d46650/schema)