Update Custom Field By Id

PUT 
/custom-fields/:id

Update Custom Field By Id

info

Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.

Request

Version stringrequired

API Version

Available optionsv3

id stringrequired

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

namestring

Field name

descriptionstring

Description of the field

placeholderstring

Placeholder text for the field

showInFormsbooleanrequired

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.

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "Name",
  "description": "string",
  "placeholder": "string",
  "showInForms": true,
  "options": [
    {
      "key": "string",
      "label": "string",
      "url": "string"
    }
  ],
  "acceptedFormats": ".pdf",
  "maxFileLimit": 2
}

application/json

Successful response

application/json

Schema

Schema

fieldobject

Example (auto)

{
  "field": {
    "locationId": "ve9EPM428h8vShlRW1KT",
    "name": "Name",
    "description": "string",
    "placeholder": "string",
    "showInForms": true,
    "options": [
      {
        "key": "string",
        "label": "string",
        "url": "string"
      }
    ],
    "acceptedFormats": ".pdf",
    "id": "string",
    "objectKey": "custom_object.pet",
    "dataType": "TEXT",
    "parentId": "3v34PM428h8vShlRW1KT",
    "fieldKey": "custom_object.pet.name",
    "allowCustomOption": true,
    "maxFileLimit": 2,
    "dateAdded": "2024-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z"
  }
}