Uptimeify Docs
Custom fields

Update Custom Field

Updates a custom field definition. All fields are optional.

PATCH /api/custom-fields/:id

Request Body (all optional)

FieldTypeDescription
namestringDisplay name
fieldTypestringtext, select, or multiselect
isRequiredbooleanWhether the field is required
displayOrdernumberSort order
optionsarrayOptions for select/multiselect
placeholderstring|nullPlaceholder text
helpTextstring|nullHelp text
showInTablebooleanShow in table views
isActivebooleanSoft delete (set to false)

Example (cURL)

curl -X PATCH "$BASE_URL/api/custom-fields/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Environment", "options": ["production", "staging", "development", "qa"] }'

Response

Returns the updated custom field object. See Error Codes for error responses.

On this page