---
title: Update Field Metadata
slug: update-field-metadata
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "UPBWuoGScYXShwv1-sccv",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}",
    "servers": [
      {
        "url": "https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Update Field Metadata",
    "description": "<p>Update field metadata properties. Currently supports updating the display format and starting value of auto number fields, as well as other field properties like description and validation rules.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "objectApiName",
          "type": "string",
          "example": "Order",
          "description": "The API name of the object containing the field to update"
        },
        {
          "kind": "required",
          "name": "fieldApiName",
          "type": "string",
          "example": "InvoiceNumber__c",
          "description": "The API name of the field to update"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "The request to update a field's metadata.",
          "customType": "UpdateFieldRequest",
          "schema": [
            {
              "name": "name",
              "kind": "optional",
              "type": "string",
              "description": "",
              "minLength": 0,
              "maxLength": 220
            },
            {
              "name": "description",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "creatable",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "updatable",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "filterable",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "sortable",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "encrypted",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "inlineHelpText",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "required",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "unique",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "length",
              "kind": "optional",
              "type": "integer<int32>",
              "description": "",
              "format": "int32"
            },
            {
              "name": "valueSet",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "precision",
              "kind": "optional",
              "type": "integer<int32>",
              "description": "",
              "format": "int32"
            },
            {
              "name": "scale",
              "kind": "optional",
              "type": "integer<int32>",
              "description": "",
              "format": "int32"
            },
            {
              "name": "autoNumberSetting",
              "kind": "optional",
              "type": "object",
              "description": "auto number customization settings including displayFormat and startValue",
              "example": "{\"displayFormat\":\"CUSTOM-INV-{00000000}\",\"startValue\":1}",
              "modelRef": "#/components/schemas/AutoNumberSetting",
              "customType": "AutoNumberSetting",
              "schema": [
                {
                  "name": "displayFormat",
                  "kind": "optional",
                  "type": "string",
                  "description": "Auto number display format",
                  "example": "CUSTOM-INV-{00000000}"
                },
                {
                  "name": "startValue",
                  "kind": "optional",
                  "type": "integer<int64>",
                  "description": "Starting number of the auto number field",
                  "example": 1,
                  "format": "int64",
                  "minimum": 1,
                  "maximum": 999999999999
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/UpdateFieldRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "default",
        "description": "default response",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// default response\n{\n  \"name\": \"\"\n}"
          },
          {
            "label": "Update Field Metadata Response",
            "code": "{\n  \"name\": \"name\"\n}"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "CreateFieldResponse",
            "schema": [
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/CreateFieldResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "phgeWhCmhy4QjqT0pjU5w",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request PATCH \\\n     --url https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "IZhyfY-OYB8Gx1GJ6FAvK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'PATCH',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "G34G-8sL4ausyYL_84Px0",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "X84AtX5v1VLb4vMmMZoBk",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "phgeWhCmhy4QjqT0pjU5w"
    },
    "results": {
      "languages": [
        {
          "id": "1FGXEftWFUFgM6Lp1gy96",
          "language": "default",
          "code": "// default response\n{\n  \"name\": \"\"\n}",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// default response\n{\n  \"name\": \"\"\n}"
            },
            {
              "label": "Update Field Metadata Response",
              "code": "{\n  \"name\": \"name\"\n}"
            }
          ]
        }
      ],
      "selectedLanguageId": "1FGXEftWFUFgM6Lp1gy96"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}