---
title: "Update a custom field"
method: PATCH
path: "/api/workspaces/{workspaceId}/custom-fields/{fieldId}"
tags: ["Custom Fields"]
---

# Update a custom field

`PATCH /api/workspaces/{workspaceId}/custom-fields/{fieldId}`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/custom-fields/{fieldId}`
- Auth: API key in cookie `hiveship_access`

## Path parameters

- `fieldId` string, required

## Request body

- object
  - `name` string
  - `options` object[], nullable
    - `value` string, required
    - `label` string, required
    - `color` string, nullable
  - `description` string, nullable
  - `required` boolean
  - `sortOrder` number

## Response `200`

Updated custom field

- object
  - `success` boolean, required
  - `data` object, required
    - `id` string, cuid, required
    - `name` string, required
    - `type` 'TEXT' | 'NUMBER' | 'DATE' | 'SELECT' | 'MULTI_SELECT' | 'URL' | 'BOOLEAN', required
    - `options` object[], nullable, required
      - `value` string, required
      - `label` string, required
      - `color` string, nullable
    - `description` string, nullable, required
    - `required` boolean, required
    - `sortOrder` number, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Validation error
- `404`: Field not found

---

[API](https://skmtc.dev/hiveship/apis/hiveship-api.md) · [All operations](https://skmtc.dev/hiveship/apis/hiveship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hiveship/apis/hiveship-api/revisions/73d3e26544e4?raw)