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

# Update a custom field

`PATCH /custom-fields/{id}`

## Request

- Base URL: `https://api-staging.fanheroapi.com`
- URL: `https://api-staging.fanheroapi.com/custom-fields/{id}`
- Auth: API key in header `apiKey`

## Headers

- `organization` string, required

## Request body

- UpdateCustomFieldInput
  - `fields` CustomFieldInput[], required
    - `name` string, required: Custom field name
    - `type` 'TYPE_STRING' | 'TYPE_BOOLEAN' | 'TYPE_NUMBER' | 'TYPE_ARRAY', required: Custom field type
    - `required` boolean, required

## Response `200`

Custom Field updated

- ResponseCustomFieldsOutput
  - `id` string, required
  - `organization` string, required: Organization ID
  - `fields` ResponseFieldOutput[], required: Fields
    - `name` string, required: Custom field name
    - `type` 'TYPE_STRING' | 'TYPE_BOOLEAN' | 'TYPE_NUMBER' | 'TYPE_ARRAY', required: Custom field type
    - `required` boolean, required: If **True**, the custom field is required.
  - `created_at` string, date-time, required: Date and time the custom field was created

---

[API](https://skmtc.dev/fanhero/apis/user-management-endpoints.md) - [All operations](https://skmtc.dev/fanhero/apis/user-management-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/fanhero/apis/user-management-endpoints/revisions/3f982670c057?raw)