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

# Replace the picklist options of a text picklist field

> Replaces the option list (and optional display labels) of a text or text_list picklist field. Removing an option that records still use is rejected. Pill and lifecycle-stage fields, standard fields that were never customised, and a project's or a task's built-in fields (changed in the app's Object Manager) are not supported. On a custom object, a pill field's options can be replaced too, as the app's Object Manager replaces them: values records already hold are kept. Returns the field's definition.



## OpenAPI

````yaml /api/statisfy-api.openapi.json put /v1/fields/{field_key}/options
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/fields/{field_key}/options:
    put:
      tags:
        - fields
      summary: Replace the picklist options of a text picklist field
      description: >-
        Replaces the option list (and optional display labels) of a text or
        text_list picklist field. Removing an option that records still use is
        rejected. Pill and lifecycle-stage fields, standard fields that were
        never customised, and a project's or a task's built-in fields (changed
        in the app's Object Manager) are not supported. On a custom object, a
        pill field's options can be replaced too, as the app's Object Manager
        replaces them: values records already hold are kept. Returns the field's
        definition.
      operationId: fields_update_options
      parameters:
        - in: path
          name: field_key
          required: true
          schema:
            type: string
        - description: >-
            The object the field belongs to: one of account, contact,
            opportunity, project, task, user, or a custom object's key (GET
            /v1/objects lists them)
          in: query
          name: object
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                option_labels:
                  anyOf:
                    - additionalProperties:
                        type: string
                      type: object
                    - type: 'null'
                  default: null
                  title: Option Labels
                options:
                  items:
                    type: string
                  title: Options
                  type: array
              required:
                - options
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldDef'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    FieldDef:
      properties:
        currency_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency Code
        formula:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: >-
            Set on a formula field: how its value is computed, in the shape
            `formula` takes on POST /v1/fields
          title: Formula
        hidden:
          default: false
          title: Hidden
          type: boolean
        key:
          title: Key
          type: string
        kind:
          enum:
            - standard
            - custom
          title: Kind
          type: string
        label:
          title: Label
          type: string
        mandatory:
          default: false
          title: Mandatory
          type: boolean
        object:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The object whose id(s) the value holds: set on reference fields (one
            id) and on id lists such as a contact's accounts (type text_list)
          title: Object
        option_labels:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Option Labels
        options:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Options
        owner:
          default: statisfy
          enum:
            - statisfy
            - crm
            - warehouse
            - integration
            - ai
            - computed
          title: Owner
          type: string
        syncs_to_crm:
          default: false
          title: Syncs To Crm
          type: boolean
        type:
          title: Type
          type: string
        writable:
          default: false
          title: Writable
          type: boolean
      required:
        - key
        - label
        - type
        - kind
      title: FieldDef
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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