---
title: "PATCH /ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}"
method: PATCH
path: "/ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}"
tags: ["CustomField"]
---

# PATCH /ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}

`PATCH /ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}`

## Request

- Base URL: `https://api.enviance.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.enviance.com/ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/enviance/apis/restapi/docs/ver2/CostomFieldService.svc/customFields/:customFieldIdOrName/patch.ts> (a function with typed inputs; its response is checked against the schema)

envianceSdk.customFields.updateCustomField
```
[
    "customfieldIDorName",
    {
        "caption": "Custom Field Caption",
        "captionLocalizations": [
            {
                "culture": "en-US",
                "value": "Caption US"
            },
            {
                "culture": "ru-RU",
                "value": "Caption RU"
            },
            {
                "culture": "zh-CN",
                "value": "Caption Chinese"
            },
            {
                "culture": "en-GB",
                "value": "Caption UK"
            },
            {
                "culture": "es-MX",
                "value": "Caption Spanish"
            }
        ],
        "dataType": "Number",
        "description": "Custom Field Description",
        "descriptionLocalizations": [
            {
                "culture": "en-US",
                "value": "Description (United States)"
            },
            {
                "culture": "ru-RU",
                "value": "Description  (Russia)"
            },
            {
                "culture": "zh-CN",
                "value": "Description (Chinese)"
            },
            {
                "culture": "en-GB",
                "value": "Description (United Kingdom)"
            },
            {
                "culture": "es-MX",
                "value": "Description Spanish"
            }
        ],
        "hyperlinkType": null,
        "isLinkedList": false,
        "isListValuesByTemplate": null,
        "isSensitiveData": true,
        "label": null,
        "listItems": [
            {
                "id": "175d915f-9d70-40fe-a87b-d4b87b8ef721",
                "value": "test",
                "valueLocalizations": [
                    {
                        "culture": "en-US",
                        "value": "test US"
                    },
                    {
                        "culture": "ru-RU",
                        "value": "test RU"
                    },
                    {
                        "culture": "zh-CN",
                        "value": "test Chinese"
                    },
                    {
                        "culture": "en-GB",
                        "value": "test UK"
                    },
                    {
                        "culture": "es-MX",
                        "value": "test Spanish"
                    }
                ]
            }
        ],
        "name": "Custom Field Name",
        "size": null,
        "trackValueHistory": false,
        "valueEntryMethod": "Dropdown List"
    },
    "onsuccess",
    "onerror"
]
```

## Path parameters

- `customFieldIdOrName` string, required

## Headers

- `EnvApi-Systemid` string
- `EnvApi-Packageid` string
- `EnvApi-Udf-DateTime-Iso-In-CustomFields` string
- `EnvApi-Udf-DateTime-ReadInUserTz` string
- `EnvApi-Udf-Value-Invariant` string
- `EnvApi-Localization-All` string
- `x-client-request-id` string

## Request body

- PartialUpdateCustomField
  - `customFieldInfo` EnvianceRestServicesVer2CustomFieldsCustomFieldInfo
    - `description` string
    - `descriptionLocalizations` EnvianceRestServicesCommonLocalizationInfo[]
      - `culture` string
      - `value` string
    - `caption` string
    - `captionLocalizations` EnvianceRestServicesCommonLocalizationInfo[]
      - `culture` string
      - `value` string
    - `size` integer
    - `dataType` 'Text' | 'Float' | 'Datetime' | 'Boolean' | 'Formula' | 'Hyperlink' | 'CitationHyperlink' | 'UniqueTag' | 'Undefined' | 'Label', enum
    - `valueEntryMethod` 'Text' | 'TextWithHistory' | 'DropdownList' | 'CheckBox' | 'Date' | 'Time' | 'DateAndTime' | 'AutoIncrement' | 'ManualIncrement' | 'MultiSelectionList' | 'CalculatedNumber' | 'PredefinedNumber' | 'PredefinedTime' | 'NumericLookup', enum
    - `hyperlinkType` 'DefaultURL' | 'ActivityProperties' | 'TaskProperties' | 'ObjectProperties' | 'ChemicalProperties' | 'MaterialProperties' | 'ChemicalListProperties' | 'CitationProperties' | 'TaskCompletion' | 'DataEntry', enum
    - `isListValuesByTemplate` boolean
    - `trackValueHistory` boolean
    - `isLinkedList` boolean
    - `label` string
    - `labelLocalizations` EnvianceRestServicesCommonLocalizationInfo[]
      - `culture` string
      - `value` string
    - `listItems` EnvianceRestServicesVer2CustomFieldsListItemInfo[]
      - `id` string, guid
      - `value` object
      - `alias` string
      - `linkedItems` string[]
      - `valueLocalizations` EnvianceRestServicesCommonLocalizationInfo[]
        - `culture` string
        - `value` string
      - `aliasLocalizations` EnvianceRestServicesCommonLocalizationInfo[]
        - `culture` string
        - `value` string
      - `isUsed` boolean
      - `isUsedCalc` boolean
    - `isSensitiveData` boolean
    - `sortOptionsByValue` boolean
    - `updated` string, date-time
    - `linkedListId` string, guid
    - `autoIncrement` boolean
    - `grandChilds` string[]
    - `value` object
    - `precision` integer
    - `links` EnvianceRestServicesCommonSystemQuickLink[]
      - `systemQuickLinkId` string, guid
      - `name` string
      - `url` string
      - `type` string
    - `id` string, guid
    - `name` string

## Response `default`

not available

---

[API](https://skmtc.dev/enviance/apis/restapi.md) - [All operations](https://skmtc.dev/enviance/apis/restapi/llms.txt) - [OpenAPI document](https://skmtc.dev/enviance/apis/restapi/revisions/45b2200a8cf2?raw)