UpdateCustomFieldCommandRequestInput

The ID of the custom field to update.

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

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

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.

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.

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

Indicates that user interfaces hide the field.

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.

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

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

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.