> ## 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 ; 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. > 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. > 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 customer (PUT) > The PUT form of `PATCH /api/v2025-06/customers/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml put /api/v2025-06/customers/{id} openapi: 3.1.0 info: title: Fluid Admin v2025-06 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": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: orders description: >- Read an order's detail and journey, and preview the points a refund of a selection returns before it is sent. x-fluid-section: Commerce - name: payments-reports description: >- Report on a company's payments over a period: transaction volume and amount, gateway latency, and approval and error rates, overall or per payment account. x-fluid-section: Payments - name: feature-flags description: >- Read and change a company's feature flags, and, for root admins, read the flag catalogue with each flag's summary and description. x-fluid-section: Developers - name: tokens description: >- Create and manage the company's API credentials: partner and public tokens, and the scoped clients that replace them for a company on identity sign-in, and for every company once scoped client creation is switched on for all. x-fluid-section: Developers - name: products description: >- Products, variants and their prices, including the per-price-type price grid of a bundle product. x-fluid-section: Commerce - name: tiktok description: >- The company's TikTok Shop connection, its logistics warehouses, category tree, product listings, and orders. x-fluid-section: Sales channels - name: ads description: >- The ad accounts a company advertises from. List what a connected Meta Business token can see and pick the ad account, Facebook Page and Instagram account Fluid launches ads into. Campaigns themselves stay on Meta. x-fluid-section: Sales channels - name: members description: >- Members and the member types that group them, including the company's default shopper member type. x-fluid-section: Members paths: /api/v2025-06/customers/{id}: put: tags: - customers summary: Update a customer (PUT) description: >- The PUT form of `PATCH /api/v2025-06/customers/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. operationId: admin_v2025_06_customers_put parameters: - name: id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UpdateCustomer' responses: '200': $ref: '#/components/responses/UpdateCustomerOk' '401': $ref: '#/components/responses/UpdateCustomerUnauthorized' '422': $ref: '#/components/responses/UpdateCustomerUnprocessable' security: - bearer_auth: [] components: requestBodies: UpdateCustomer: required: true content: application/json: example: customer: phone: '+16035550172' sms_marketing: true notes: Moved to the Nashua branch manager's office. metadata: loyalty_tier: platinum referral_source: scranton-trade-show address: name: Holly Flax address1: 22 Main Street city: Nashua state: NH postal_code: '03060' country: US schema: type: object properties: customer: type: object properties: email: type: string first_name: type: string last_name: type: string phone: type: string account_id: type: string external_id: type: string description: >- PATCH /api/v2025-06/members/{member_id} is the preferred endpoint for member external IDs. role: type: string metadata: type: object email_marketing: type: boolean sms_marketing: type: boolean notes: type: string address: type: object description: >- Default address for the customer. `country` is an ISO 3166-1 alpha-2 code. required: - address1 - city - state - postal_code - country properties: name: type: string description: Name on the address. Omit to keep the existing name. address1: type: string address2: type: string city: type: string state: type: string description: State, province or region. postal_code: type: string country: type: string description: ISO 3166-1 alpha-2 country code. tax_exempt: type: boolean sales_tax_id: type: - string - 'null' active: type: boolean description: >- Set to false to deactivate the customer, or true to reactivate. language_code: type: string description: ISO 639-1 code of the customer's preferred language. rank_id: type: integer description: >- ID of the Rank to assign to the customer. Must belong to the current company. responses: UpdateCustomerOk: description: Success content: application/json: example: customer: id: 48213 full_name: Holly Flax email: holly.flax@dundermifflin.com created_at: '2026-09-14T15:04:22Z' user_company_id: 77120 metadata: loyalty_tier: platinum referral_source: scranton-trade-show email_marketing: true sms_marketing: true tax_exempt: false sales_tax_id: null account_id: DM-CUST-10482 phone: '+16035550172' external_id: crm-99812 member_id: 01926f3a-5c2e-7b41-9d8e-2f4a6c1b7e93 first_name: Holly last_name: Flax verified_email: true orders_count: 3 display_total_spent: $164.97 name: Holly Flax role: customer last_order_id: 90417 notes: Moved to the Nashua branch manager's office. active: true total_spent: 164.97 customer_notes: [] default_address: id: 30551 name: Holly Flax address1: 22 Main Street address2: null address3: null city: Nashua state: NH subdivision_code: NH postal_code: '03060' country_code: US phone: '+16035550172' country_num_code: 840 default: true addresses: - id: 30551 name: Holly Flax address1: 22 Main Street address2: null address3: null city: Nashua state: NH subdivision_code: NH postal_code: '03060' country_code: US phone: '+16035550172' country_num_code: 840 default: true payment_methods: [] is_rep: false is_discarded: false member_type_slug: customer points: 120 points_decimal: '120.0000' attributable_rep: null sponsor: id: 1882 first_name: Dwight last_name: Schrute image_url: null external_id: null username: dwight-schrute agreement_acceptances: [] username: null rank: null language_code: en legacy_user_company_id: 77120 legacy_customer_id: 48213 meta: request_id: c0a8012e-7f3b-4d6a-9e21-5b8d4f2a6c17 timestamp: '2026-09-30T14:15:22Z' schema: type: object properties: customer: type: object properties: id: type: integer full_name: type: string email: type: string created_at: type: string format: date-time user_company_id: type: - integer - 'null' metadata: type: object email_marketing: type: boolean sms_marketing: type: boolean account_id: type: - string - 'null' phone: type: - string - 'null' external_id: type: - string - 'null' first_name: type: - string - 'null' last_name: type: - string - 'null' verified_email: type: boolean orders_count: type: integer display_total_spent: type: string name: type: string role: type: string member_type_slug: type: - string - 'null' last_order_id: type: - integer - 'null' notes: type: - string - 'null' active: type: boolean total_spent: type: - string - number customer_notes: type: array items: type: object default_address: type: - object - 'null' addresses: type: array items: type: object payment_methods: type: array items: type: object is_rep: type: boolean is_discarded: type: boolean points: type: integer points_decimal: type: string pattern: ^-?\d+\.\d{4}$ description: >- The points balance as an exact decimal string with four decimal places. `points` keeps the whole number. example: '120.0000' attributable_rep: type: - object - 'null' sponsor: type: - object - 'null' agreement_acceptances: type: array items: $ref: '#/components/schemas/AgreementAcceptance' tax_exempt: type: boolean sales_tax_id: type: - string - 'null' rank: type: - object - 'null' properties: id: type: integer name: type: string external_id: type: - string - 'null' meta: $ref: '#/components/schemas/Meta' additionalProperties: false UpdateCustomerUnauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' UpdateCustomerUnprocessable: description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: AgreementAcceptance: type: object description: >- One recorded acceptance of an agreement, with the agreement text as it stood when accepted. properties: id: type: integer description: The acceptance record's ID. agreement_id: type: integer description: The accepted agreement's ID. title: type: - string - 'null' description: The agreement's current title. required: type: boolean description: Whether the agreement was required when it was accepted. accepted_at: type: string format: date-time description: When the agreement was accepted. acceptance_context: type: string enum: - checkout - company_onboarding - enrollment - login description: Where the agreement was accepted. acceptance_method: type: string enum: - customer - agent_confirmed description: >- How the agreement was accepted. `customer` means the customer accepted it directly. `agent_confirmed` means an admin placing the order confirmed the customer's agreement on their behalf. order_id: type: - integer - 'null' description: >- The order the agreement was accepted with, or null when it was accepted outside an order (at login or company onboarding). content_snapshot: type: - string - 'null' description: The agreement's HTML as it stood when accepted. required: - id - agreement_id - title - required - accepted_at - acceptance_context - acceptance_method - order_id Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: type: object description: >- Rotulus cursor-pagination metadata (Api::MetaPagination#to_h), present on cursor-paginated responses such as GET /api/v2025-06/prices. total_count is only present when the endpoint opts into a total count. properties: cursor: type: - string - 'null' limit: type: integer prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' total_count: type: integer UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.