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

> ## Agent Instructions
> For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract.
> Authenticate with the header Authorization: Bearer <token>; public storefront read endpoints require no auth.
> To sign a new merchant up for Fluid programmatically, run `fluid signup` from the Fluid CLI, or call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, commercetools, WooCommerce, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate.
> Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is /<username>/products/<slug>; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a.
> After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy, or inline through the MCP site_deploy tool when it imports nothing. See /sites/functions and /sites/rest-api.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors.
> Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile.
> The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country).
> api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.
> Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other.
> For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces.
> Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings.
> Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties.
> Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables.
> A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation.
> The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations.
> Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check.
> Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times.

# Update a metafield definition

> Changes a metafield definition's display fields and settings. Send only the fields to change. The namespace, key, value type, owner resource and validation rules cannot be changed: they are ignored when sent, and the request still returns 200. `PUT` is routed to the same operation.

To turn translations on or off for the field, send `"translatable": true` or `"translatable": false`. Turning it off keeps the translations already saved. The setting works only for companies with the translatable metafields feature turned on. For any other company the value is ignored and the request still returns 200 with the stored value, so check `translatable` in the response.

Requires a company admin credential with the Developer update permission.



## OpenAPI

````yaml /api-reference/admin-v2.yaml patch /api/v2/metafield_definitions/{id}
openapi: 3.1.0
info:
  title: Fluid Admin v2 API
  description: |
    **Sandbox test companies.** A sandbox test company is linked to a live
    company. While the test company cannot be reached, because sandbox access
    is turned off for its live company or the live company was deleted, every
    operation in this API that resolves the company from the request's
    credential refuses a credential for it with `403` and the body
    `{"error": "<message>"}`, before the operation runs. The refusal is
    documented here once rather than on each operation.
  version: v2
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
security: []
tags:
  - name: metafield-definitions
    description: >-
      The custom fields a company adds to its products, variants, enrollment
      packs, members and other records. A definition fixes a field's namespace,
      key, type and validation rules, and whether its values can be translated.
      Create and change definitions here, then store values with the metafields
      operations.
    x-fluid-section: Settings
paths:
  /api/v2/metafield_definitions/{id}:
    patch:
      tags:
        - metafield-definitions
      summary: Update a metafield definition
      description: >-
        Changes a metafield definition's display fields and settings. Send only
        the fields to change. The namespace, key, value type, owner resource and
        validation rules cannot be changed: they are ignored when sent, and the
        request still returns 200. `PUT` is routed to the same operation.


        To turn translations on or off for the field, send `"translatable":
        true` or `"translatable": false`. Turning it off keeps the translations
        already saved. The setting works only for companies with the
        translatable metafields feature turned on. For any other company the
        value is ignored and the request still returns 200 with the stored
        value, so check `translatable` in the response.


        Requires a company admin credential with the Developer update
        permission.
      operationId: admin_v2_metafield_definitions_update
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the metafield definition.
          schema:
            type: integer
            examples:
              - 4812
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetafieldDefinitionUpdateRequest'
            examples:
              turn_translatable_on:
                summary: Make an existing field translatable
                value:
                  metafield_definition:
                    translatable: true
              rename:
                summary: Rename a field and pin it
                value:
                  metafield_definition:
                    name: Product tagline
                    pinned: true
      responses:
        '200':
          description: The definition after the change.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetafieldDefinitionResponse'
              example:
                metafield_definition:
                  id: 4812
                  company_id: 1023
                  namespace: custom
                  key: tagline
                  name: Tagline
                  description: A short line shown under the product title.
                  value_type: single_line_text_field
                  validation_rules: null
                  owner_resource: Product
                  pinned: false
                  position: 1
                  locked: false
                  searchable: false
                  translatable: true
                  list_type: false
                  reference_type: false
                  supported_validations:
                    - min
                    - max
                    - choices
                    - regex
                  validation_description: Single line text up to 5000 characters
                  category_ids: []
                  created_at: '2026-11-16T16:40:58Z'
                  updated_at: '2026-11-16T16:41:20Z'
                meta:
                  request_id: 6389a5b2-042b-4ae9-8b51-c0fe906e673d
                  timestamp: '2026-11-16T16:41:20Z'
        '401':
          description: >-
            The credential is missing or invalid, or does not belong to a
            company admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
              example:
                message: Invalid credentials.
        '403':
          description: The credential does not hold the Developer update permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionDeniedResponse'
              example:
                error: Not authorized.
        '404':
          description: The company has no metafield definition with this ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_message: Metafield Definition not found
                errors:
                  id:
                    - not found
                meta:
                  request_id: 9b3c8b7c-0d27-4ea0-86e0-33b4ec4104ae
                  timestamp: '2026-11-16T16:41:20Z'
        '422':
          description: >-
            The `id` in the path is not an integer, or the change is not valid,
            for example the name is empty, a category is not the company's, or
            `translatable` is true for an owner resource, value type or rule
            that cannot be translated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                translatable_not_supported:
                  summary: Translatable on a type that cannot be translated
                  value:
                    error_message: Failed to update Metafield Definition
                    errors:
                      translatable:
                        - >-
                          is only supported for these value types:
                          single_line_text_field, multi_line_text_field,
                          rich_text_field, list.single_line_text_field, url
                    meta:
                      request_id: 3c0f2d8e-5b0a-4c41-9a7e-0b5a43c7a1d2
                      timestamp: '2026-11-16T16:41:20Z'
                id_not_an_integer:
                  summary: The id in the path is not an integer
                  value:
                    error_message: Invalid parameters
                    errors:
                      id:
                        - must be an integer
                    meta:
                      request_id: 5b7d0e91-2c4a-4f6e-8a13-9d0c6e4b7a22
                      timestamp: '2026-11-16T16:41:20Z'
      security:
        - bearer_auth: []
components:
  schemas:
    MetafieldDefinitionUpdateRequest:
      type: object
      required:
        - metafield_definition
      properties:
        metafield_definition:
          type: object
          description: >-
            The fields to change. Fields left out stay as they are. The
            namespace, key, value type, owner resource and validation rules
            cannot be changed, and are ignored when sent.
          properties:
            name:
              type: string
              minLength: 1
              maxLength: 100
              description: The display name shown in the admin.
              example: Product tagline
            description:
              type:
                - string
                - 'null'
              description: >-
                Help text for people who fill in the field. Send null to clear
                it.
              example: A short line shown under the product title.
            category_ids:
              type:
                - array
                - 'null'
              description: >-
                The IDs of the company's categories to group the definition
                under. The list replaces the current one, and an empty list
                clears it. Leave it out to keep the current categories. A
                category the company does not own is refused with 422.
              items:
                type: integer
              example:
                - 14
            pinned:
              type: boolean
              description: Whether the admin shows the field ahead of the others.
              example: true
            position:
              type: integer
              description: >-
                The sort order among the company's definitions for the same
                owner resource. Lower numbers come first.
              example: 1
            locked:
              type: boolean
              description: >-
                Whether to protect the definition's metafields from direct
                changes and deletion.
              example: false
            searchable:
              type: boolean
              description: >-
                Members only. Lets droplets and API clients look up members by
                this metafield's value. Refused with 422 unless the owner
                resource is `Company::Member` and the type is `json`,
                `single_line_text_field` or `number_integer`.
              example: false
            translatable:
              type: boolean
              description: >-
                Turns translations on or off for the field's values. Turning it
                off keeps the translations already saved, and they come back if
                it is turned on again. Only for companies with the translatable
                metafields feature turned on. For any other company the value is
                ignored, the request still succeeds and the stored value is
                returned unchanged, so read `translatable` in the response to
                confirm it took effect.


                With the feature on, turning it on is refused with 422 for an
                owner resource other than Product, Variant or EnrollmentPack,
                for a value type other than `single_line_text_field`,
                `multi_line_text_field`, `rich_text_field`,
                `list.single_line_text_field` or `url`, and for a definition
                with a `choices` rule.
              example: true
    MetafieldDefinitionResponse:
      type: object
      required:
        - metafield_definition
        - meta
      properties:
        metafield_definition:
          $ref: '#/components/schemas/MetafieldDefinition'
        meta:
          $ref: '#/components/schemas/Meta'
    UnauthorizedResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    PermissionDeniedResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    ErrorResponse:
      type: object
      required:
        - error_message
        - errors
        - meta
      properties:
        error_message:
          type: string
        errors:
          $ref: '#/components/schemas/ErrorBag'
        meta:
          $ref: '#/components/schemas/Meta'
    MetafieldDefinition:
      type: object
      description: >-
        A custom field a company defines for one kind of record. Metafield
        values reference a definition by its namespace, key and owner resource.
      required:
        - id
        - company_id
        - namespace
        - key
        - name
        - value_type
        - owner_resource
        - searchable
        - translatable
      properties:
        id:
          type: integer
          description: >-
            The definition's ID. Use it in the path of the show, update and
            delete operations.
          example: 4812
        company_id:
          type: integer
          description: The ID of the company that owns the definition.
          example: 1023
        namespace:
          type: string
          description: >-
            Groups related definitions. Up to 20 letters, numbers and
            underscores. Fixed once the definition is created.
          example: custom
        key:
          type: string
          description: >-
            Identifies the definition within its namespace and owner resource.
            Up to 30 letters, numbers and underscores. Fixed once the definition
            is created.
          example: tagline
        name:
          type: string
          description: The display name shown in the admin. Up to 100 characters.
          example: Tagline
        description:
          type:
            - string
            - 'null'
          description: Help text for people who fill in the field.
          example: A short line shown under the product title.
        value_type:
          type: string
          description: >-
            The type of value the field holds, such as `single_line_text_field`,
            `number_integer` or `list.url`. Fixed once the definition is
            created. `GET /api/v2/metafield_definitions/supported_data_types`
            lists every type.
          example: single_line_text_field
        validation_rules:
          type:
            - object
            - string
            - 'null'
          description: >-
            The rules a value must meet, keyed by rule name, for example
            `{"max": 80}`. Which rules a type supports is in
            `supported_validations`. Null when the definition has no rules.
            Fixed once the definition is created.
          example:
            max: 80
        owner_resource:
          type: string
          description: >-
            The kind of record the definition's metafields attach to, as stored.
            A request that names `Member`, `Customer`, `Media` or `Playlist` is
            stored as `Company::Member`, `Company::Member`, `Medium` or
            `Library`. Fixed once the definition is created.
          example: Product
        pinned:
          type: boolean
          description: Whether the admin shows the field ahead of the others.
          example: false
        position:
          type: integer
          description: >-
            The sort order among the company's definitions for the same owner
            resource. Lower numbers come first.
          example: 5
        locked:
          type: boolean
          description: >-
            Whether the definition's metafields are protected from direct
            changes and deletion.
          example: false
        searchable:
          type: boolean
          description: >-
            Members only. When true, droplets and API clients can look up
            members by this metafield's value with `filter[metafield]` on `GET
            /api/v2025-06/members`.
          example: false
        translatable:
          type: boolean
          description: >-
            Whether the field's values can have per-language translations. See
            the `translatable` field of the create and update requests for the
            rules.
          example: true
        list_type:
          type: boolean
          description: >-
            True for a list type such as `list.single_line_text_field`, whose
            values are arrays.
          example: false
        reference_type:
          type: boolean
          description: >-
            True for a type whose values point at another record, such as
            `product_reference`.
          example: false
        supported_validations:
          type: array
          description: The validation rule names this value type accepts.
          items:
            type: string
          example:
            - min
            - max
            - choices
            - regex
        validation_description:
          type:
            - string
            - 'null'
          description: A plain-language description of the value type.
          example: Single line text up to 5000 characters
        category_ids:
          type: array
          description: >-
            The IDs of the categories the definition is grouped under in the
            admin.
          items:
            type: integer
          example: []
        metafields_count:
          type: integer
          description: >-
            How many standalone metafield records use this definition. Values
            stored directly on a product, variant or other record's own
            metafields are not counted. Returned by the list operation only.
          example: 12
        created_at:
          type: string
          format: date-time
          description: When the definition was created.
          example: '2026-11-16T16:40:58Z'
        updated_at:
          type: string
          format: date-time
          description: When the definition was last changed.
          example: '2026-11-16T16:40:58Z'
    Meta:
      type: object
      properties:
        request_id:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
    ErrorBag:
      description: >-
        Validation errors keyed by field, a list of errors, a single error
        message, or null when no structured error details are available.
      anyOf:
        - type: string
        - type: array
          items:
            $ref: '#/components/schemas/ErrorValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/ErrorValue'
        - type: 'null'
    ErrorValue:
      description: A validation or API error value.
      anyOf:
        - type: string
        - type: array
          items:
            type: string
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    JsonValue:
      description: >-
        Any valid JSON value for provider, integration, theme, metadata, or
        other dynamic payloads whose keys are not fixed by the API contract.
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: Bearer token authentication

````

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