---
title: "Update Custom Field"
method: PATCH
path: "/api/custom-fields/{id}"
tags: ["Custom Fields"]
---

# Update Custom Field

`PATCH /api/custom-fields/{id}`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/custom-fields/{id}`
- Auth: HTTP bearer

PATCH /api/custom-fields/:id

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `fieldType` 'text' | 'number' | 'email' | 'url' | 'select'
  - `isRequired` boolean
  - `displayOrder` integer
  - `options` string[]
  - `placeholder` string, nullable
  - `helpText` string, nullable
  - `showInTable` boolean
  - `isActive` boolean

## Response `200`

Successful response

- object
  - `id` integer, required
  - `organizationId` integer, required
  - `name` string, required
  - `fieldKey` string, required: Key in customer.customFields; derived from name when not given.
  - `fieldType` 'text' | 'number' | 'email' | 'url' | 'select', required
  - `isRequired` boolean, required
  - `displayOrder` integer, required
  - `options` string[], nullable, required: Choices of a select field.
  - `placeholder` string, nullable, required
  - `helpText` string, nullable, required
  - `showInTable` boolean, required
  - `isActive` boolean, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)