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

# Add or remove dropdown choices

> Safely add and/or remove dropdown choices on a `dropdown` custom field
without resending the entire choice list. Only applies to fields whose
`type` is `dropdown`.

At least one of `add` or `remove` must be provided with at least one value.
Strings in `add` that already exist are ignored; strings in `remove` that
are not present are ignored.




## OpenAPI

````yaml /api-reference/build.yaml patch /custom-fields/{customFieldId}/choices
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /custom-fields/{customFieldId}/choices:
    patch:
      tags:
        - Custom Fields
      summary: Add or remove dropdown choices
      description: >
        Safely add and/or remove dropdown choices on a `dropdown` custom field

        without resending the entire choice list. Only applies to fields whose

        `type` is `dropdown`.


        At least one of `add` or `remove` must be provided with at least one
        value.

        Strings in `add` that already exist are ignored; strings in `remove`
        that

        are not present are ignored.
      operationId: patchCustomFieldDefinitionChoices
      parameters:
        - name: customFieldId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the custom field definition
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                add:
                  type: array
                  description: Choice values to append (deduplicated against existing).
                  items:
                    type: string
                  example:
                    - Enterprise
                remove:
                  type: array
                  description: Choice values to remove from the list.
                  items:
                    type: string
                  example:
                    - Legacy
      responses:
        '200':
          description: Choices successfully updated; returns the full field definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique identifier for the custom field definition
                        example: 123
                      label:
                        type: string
                        description: >-
                          Display label for the custom field (unique across
                          definitions)
                        example: Industry
                      type:
                        type: string
                        description: Data type of the custom field
                        enum:
                          - number
                          - date
                          - string
                          - dropdown
                        example: dropdown
                      options:
                        type: object
                        nullable: true
                        description: >
                          Optional configuration for the field. Common keys:

                          - `choices` (array, required for `type: dropdown`) —
                          the selectable values

                          - `minLength` (integer) — minimum length for string
                          input

                          - `maxLength` (integer) — maximum length for string
                          input

                          - `helpText` (string, max 500) — help text shown in
                          the UI
                        properties:
                          choices:
                            type: array
                            description: Selectable values for dropdown fields
                            items:
                              oneOf:
                                - type: string
                                - type: number
                            example:
                              - Retail
                              - Wholesale
                              - DTC
                          minLength:
                            type: integer
                            minimum: 0
                            example: 0
                          maxLength:
                            type: integer
                            minimum: 1
                            example: 255
                          helpText:
                            type: string
                            maxLength: 500
                            example: Choose the primary sales channel
                        additionalProperties: true
                      object_types:
                        type: array
                        description: >-
                          Entity types this custom field applies to (e.g.
                          `sales-orders`, `products`)
                        items:
                          type: string
                        example:
                          - companies
                          - products
                      created_at:
                        type: string
                        format: date-time
                        example: '2026-04-20T14:30:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2026-04-20T14:30:00Z'
                    required:
                      - id
                      - label
                      - type
                      - object_types
        '401':
          description: Authentication credentials were missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Authentication credentials are missing or invalid
                  status_code:
                    type: integer
                    example: 401
        '403':
          description: You do not have permission to perform this action
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: You do not have permission to access this resource
                  status_code:
                    type: integer
                    example: 403
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
                  message:
                    type: string
                    example: The requested resource could not be found
                  status_code:
                    type: integer
                    example: 404
        '422':
          description: >
            Validation error. Returned when neither `add` nor `remove` provides
            any

            value, or when the target field is not of type `dropdown`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````