> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UpdateCustomFieldCommandRequestInput

> Updates a custom field. The data type and the entity type cannot be changed. - Request



**Kind**: `input`

## Fields

**`customFieldId`**: `ID!` (required)

The ID of the custom field to update.

---

**`name`**: `String`

The name of the field. It must be unique among the fields of the same entity type, ignoring letter case.

---

**`description`**: `String`

An internal description of the field. Null removes the description.

---

**`groupName`**: `String`

The name of the group the field is displayed under. A moved field is placed at the end of the new group unless 'sortOrder' is given in the same request. A name that matches an existing group of the same entity type apart from letter case uses the existing spelling.

---

**`displayLocation`**: `String`

Where user interfaces show the field. Not available for sales orders and sales order line items. Known keys: 'GENERAL', 'CUSTOM_FIELDS_TAB'. New keys can be added; handle an unknown key as not known, never as a failure.

---

**`isRequired`**: `Boolean`

Indicates that a value is expected for this field. A hint for user interfaces, not enforced by the API.

---

**`isHidden`**: `Boolean`

Indicates that user interfaces hide the field.

---

**`sortOrder`**: `Int`

The new position within the group, starting at 1; a larger value places the field at the end. Other fields of the group move accordingly.

---

**`productGroupRestriction`**: `ProductGroupRestrictionInput`

Replaces the product group restriction, which only restricts the field in user interfaces. Only for item fields. Both properties must be given.

---

**`disableAutomaticWorkflows`**: `Boolean`

If true, automatic workflows are not triggered by this call.

---

**`idempotencyKey`**: `String`

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.