> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update item field settings

> Turns item fields on or off, or makes them required, and returns the field settings.

Send a list of fields under `field_settings.item.fields`. Each entry names the field in `name`, its `module` such as `item`, and sets `enabled` and `required` as `"true"` or `"false"`. The response lists field settings under `data`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml PATCH /settings/field_settings/item
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /settings/field_settings/item:
    patch:
      tags:
        - Instance settings
      summary: Update item field settings
      description: >-
        Send a list of fields under `field_settings.item.fields`. Each entry
        names the field in `name`, its `module` such as `item`, and sets
        `enabled` and `required` as `"true"` or `"false"`. The response lists
        field settings under `data`.
      operationId: settings_update_settings_field_settings_item
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                field_settings:
                  type: object
                  properties:
                    item:
                      type: object
                      properties:
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: The field's name, such as `barcodeValue`.
                              module:
                                type: string
                                description: The module, such as `item`.
                              enabled:
                                type: string
                                description: '`"true"` or `"false"`.'
                              required:
                                type: string
                                description: '`"true"` or `"false"`.'
                            required:
                              - name
                      required:
                        - fields
                  required:
                    - item
              required:
                - field_settings
            example:
              field_settings:
                item:
                  fields:
                    - name: barcodeValue
                      module: item
                      enabled: 'true'
                      required: 'false'
      responses:
        '200':
          description: The field settings, under `data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsFieldSettingsItem'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/settings/field_settings/item" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "field_settings": {
                  "item": {
                    "fields": [
                      {
                        "name": "barcodeValue",
                        "module": "item",
                        "enabled": "true",
                        "required": "false"
                      }
                    ]
                  }
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.settings.update_settings_field_settings_item(
                {
                    "field_settings": {
                        "item": {
                            "fields": [
                                {
                                    "name": "barcodeValue",
                                    "module": "item",
                                    "enabled": "true",
                                    "required": "false",
                                }
                            ]
                        }
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.settings.updateSettingsFieldSettingsItem({
                field_settings: {item: {fields: [{name: 'barcodeValue', module: 'item', enabled: 'true', required: 'false'}]}},
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->settings->updateSettingsFieldSettingsItem([
                'field_settings' => [
                    'item' => [
                        'fields' => [
                            [
                                'name' => 'barcodeValue',
                                'module' => 'item',
                                'enabled' => 'true',
                                'required' => 'false',
                            ],
                        ],
                    ],
                ],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.settings.settings_dto.SettingsDto.SettingsFieldSettingsItem;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<SettingsFieldSettingsItem> response =
            client.settings().updateSettingsFieldSettingsItem(
                    Map.of(
                            "field_settings", Map.of(
                                    "item", Map.of(
                                            "fields", List.of(
                                                    Map.of(
                                                            "name", "barcodeValue",
                                                            "module", "item",
                                                            "enabled", "true",
                                                            "required", "false"))))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Settings.UpdateSettingsFieldSettingsItemAsync(new
            Dictionary<string, object?>

            {
                ["field_settings"] = new Dictionary<string, object?>
                {
                    ["item"] = new Dictionary<string, object?>
                    {
                        ["fields"] = new List<object?>
                        {
                            new Dictionary<string, object?>
                            {
                                ["name"] = "barcodeValue",
                                ["module"] = "item",
                                ["enabled"] = "true",
                                ["required"] = "false",
                            },
                        },
                    },
                },
            });


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.settings.updateSettingsFieldSettingsItem({
              'field_settings': {
                'item': {
                  'fields': [
                    {
                      'name': 'barcodeValue',
                      'module': 'item',
                      'enabled': 'true',
                      'required': 'false',
                    },
                  ],
                },
              },
            });

            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Settings().UpdateSettingsFieldSettingsItem(context.Background(), map[string]any{\n\t\"field_settings\": map[string]any{\n\t\t\"item\": map[string]any{\n\t\t\t\"fields\": []any{\n\t\t\t\tmap[string]any{\n\t\t\t\t\t\"name\":     \"barcodeValue\",\n\t\t\t\t\t\"module\":   \"item\",\n\t\t\t\t\t\"enabled\":  \"true\",\n\t\t\t\t\t\"required\": \"false\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    SettingsFieldSettingsItem:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SettingsFieldSettingsItemData'
        general_settings:
          $ref: '#/components/schemas/SettingsFieldSettingsItemGeneralSettings'
        message:
          type: string
        object:
          type: string
        pagination:
          description: Can be null.
        url:
          type: string
    SettingsFieldSettingsItemData:
      type: object
      properties:
        created_by:
          description: Can be null.
        created_on:
          type: string
        description:
          description: Can be null.
        display_code:
          type: string
        editable:
          description: Can be null.
        enabled:
          type: boolean
        entity:
          type: string
        field_name:
          type: string
        field_type:
          type: string
        global_search:
          type: boolean
        group_key:
          type: string
        href:
          type: string
        id:
          type: string
        last_updated_by:
          description: Can be null.
        last_updated_on:
          type: string
        mandatory:
          type: boolean
        note:
          description: Can be null.
        object:
          type: string
        sort_order:
          type: integer
    SettingsFieldSettingsItemGeneralSettings:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccount'
    SettingsFieldSettingsItemGeneralSettingsAccount:
      type: object
      properties:
        account_grouping:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountAccountGrouping
        account_management:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountAccountManagement
        additional_contact_1:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact1
        additional_contact_2:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact2
        additional_contact_3:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact3
        billing_contact:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountBillingContact
        creation_of_subsidiary_account:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountCreationOfSubsidiaryAccount
        enable_workflow_approval_for_account:
          type: string
        referral_tracking_at_account_level:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountReferralTrackingAtAccountLevel
        require_email_address_for_account:
          type: string
        require_name_to_be_unique:
          type: string
        sales_rep_tracking_at_account_level:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountSalesRepTrackingAtAccountLevel
        send_communication_as_groups:
          type: string
        shipping_contact:
          $ref: >-
            #/components/schemas/SettingsFieldSettingsItemGeneralSettingsAccountShippingContact
        unique_email_address_for_account:
          type: string
        unique_email_address_for_contacts:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountAccountGrouping:
      type: object
      properties:
        default_group:
          description: Can be null.
        enabled:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountAccountManagement:
      type: object
      properties:
        default_manager:
          description: Can be null.
        enabled:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact1:
      type: object
      properties:
        display_name:
          type: string
        enabled:
          type: string
        require_email_address_for_additional_contact_1:
          type: string
        type:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact2:
      type: object
      properties:
        display_name:
          type: string
        enabled:
          type: string
        require_email_address_for_additional_contact_2:
          type: string
        type:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountAdditionalContact3:
      type: object
      properties:
        display_name:
          type: string
        enabled:
          type: string
        require_email_address_for_additional_contact_3:
          type: string
        type:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountBillingContact:
      type: object
      properties:
        display_name:
          type: string
        enabled:
          type: string
        require_email_address_for_billing_contact:
          type: string
        type:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountCreationOfSubsidiaryAccount:
      type: object
      properties:
        default_group:
          description: Can be null.
        enabled:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountReferralTrackingAtAccountLevel:
      type: object
      properties:
        default_referral_tracking:
          description: Can be null.
        enabled:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountSalesRepTrackingAtAccountLevel:
      type: object
      properties:
        default_sales_rep_tracking:
          description: Can be null.
        enabled:
          type: string
    SettingsFieldSettingsItemGeneralSettingsAccountShippingContact:
      type: object
      properties:
        display_name:
          type: string
        enabled:
          type: string
        require_email_address_for_shipping_contact:
          type: string
        type:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.