Update Custom Field By Id

PUT 
/custom-fields/:id

Update Custom Field By Id.

info

Supports Custom Objects, Company (Business), and Project Management tasks (objectKey: "task", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.

Request

Version stringrequired

API Version

Available options2023-02-21

id stringrequired

Unique identifier of the custom field or folder

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

namestring

Field name

descriptionstring

Description of the field

placeholderstring

Placeholder text for the field

showInFormsboolean

Whether the field should be shown in forms

optionsobject[]

Options for the field. Important: Providing options will completely replace the existing options array. You must include all existing options alongside any new options you wish to add. Removal of options is not supported through this update. Applicable only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types.

acceptedFormatsstring
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Available options.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
maxFileLimitnumber

Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.

isUniqueboolean

Can only be set to false to remove a field from unique properties. Setting to true is not allowed during update and will result in an error. Only applicable for custom objects with TEXT, LARGE_TEXT, NUMERICAL, and PHONE field types.

scopesobject[]

Replace visibility scopes for Project Management / task fields (space | folder | list | workspace). Pass [] to clear scopes (location-wide). Omit to leave unchanged.

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "Name",
  "description": "Pet name field",
  "placeholder": "Enter pet name",
  "showInForms": true,
  "options": [
    {
      "key": "option_a",
      "label": "Option A"
    }
  ],
  "acceptedFormats": [
    ".pdf",
    ".jpg"
  ],
  "maxFileLimit": 2,
  "isUnique": false,
  "scopes": [
    {
      "scopeType": "space",
      "scopeId": "6a102435124ecfb348bd5506"
    }
  ]
}

application/json

Successful response

application/json

Schema

Schema

fieldobject

The custom field or folder matching the requested id

Example (auto)

{
  "field": {
    "id": "661c06b4ffde146bdb469442",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "name": "Pet Name",
    "fieldKey": "custom_object.pet.name",
    "objectKey": "custom_object.pet",
    "dataType": "TEXT",
    "parentId": "3v34PM428h8vShlRW1KT",
    "showInForms": true,
    "dateAdded": "2025-01-02T09:35:39.032Z",
    "dateUpdated": "2025-01-02T09:35:39.032Z"
  }
}