> ## 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, 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. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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 — 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. # Update reward points settings > Update reward points settings. Accessible by root admins or company admins for their own company. ## OpenAPI ````yaml /api-reference/settings-v0.yaml patch /api/settings/companies/{id}/reward_points openapi: 3.1.0 info: title: Fluid Settings API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/settings/companies/{id}/reward_points: patch: tags: - companies summary: Update reward points settings description: >- Update reward points settings. Accessible by root admins or company admins for their own company. operationId: settings_v0_update_company_reward_points parameters: - name: Authorization in: header required: true description: Bearer token for authentication schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object required: - company properties: company: type: object required: - reward_points_enabled properties: reward_points_enabled: type: boolean reward_points_apply_to: type: string enum: - total - subtotal reward_points_label_singular: type: - string - 'null' maxLength: 40 description: >- Customer-facing singular label for reward points. Blank or null restores the default "point". reward_points_label_plural: type: - string - 'null' maxLength: 40 description: >- Customer-facing plural label for reward points. Blank or null restores the default "points". example: company: reward_points_enabled: true reward_points_apply_to: subtotal reward_points_label_singular: Schrute Buck reward_points_label_plural: Schrute Bucks required: true description: Reward points settings to update responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/UpdateCompanyDetailsResponse200ApplicationJsonSchema example: id: 1405 name: Dunder Mifflin Paper Company active: true sandbox: false is_mlm: true fluid_shop: dunder-mifflin.fluid.app domain: shop.dundermifflin.com color: '#1F4E8C' tax_class: fluid appstore_url: https://apps.apple.com/us/app/dunder-mifflin/id6470182345 playstore_url: >- https://play.google.com/store/apps/details?id=com.dundermifflin.app pre_purchase_enrollment_fields: false allow_signup: true company_pays: false olumo_token: null apn_bundle: com.dundermifflin.app ibi_bundle: com.dundermifflin.app signup_url: https://shop.dundermifflin.com/join reward_points_enabled: true reward_points_apply_to_subtotal: true reward_points_label_singular: Schrute Buck reward_points_label_plural: Schrute Bucks mobile_app_identifier: DunderMifflin support_email: support@dundermifflin.com country_code: US shipping: Flat Country shipping_type: country allow_free_shipping: true email_provider: fluid meta: request_id: c4f1b9e2-7a3d-4e8b-9f21-5d6a0b3e8c47 timestamp: '2026-09-14T15:32:08Z' '401': description: Unauthorized - User is not authorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearer_auth: [] components: schemas: UpdateCompanyDetailsResponse200ApplicationJsonSchema: allOf: - $ref: '#/components/schemas/SettingsCompany' - type: object properties: meta: $ref: '#/components/schemas/Meta' UnauthorizedResponse: type: object properties: message: type: string required: - message SettingsCompany: title: Company type: object required: - id - name - active properties: id: type: integer name: type: string active: type: boolean default: true sandbox: description: Whether the company is in sandbox mode for testing type: boolean is_mlm: description: Whether the company is a Multi-Level Marketing (MLM) business type: boolean fluid_shop: type: string domain: type: - string - 'null' color: type: - string - 'null' tax_class: description: Tax class for the company type: - string - 'null' appstore_url: description: App Store URL for the company's mobile app type: - string - 'null' playstore_url: description: Google Play Store URL for the company's mobile app type: - string - 'null' pre_purchase_enrollment_fields: type: - boolean - 'null' allow_signup: description: Whether to allow self-signup type: - boolean - 'null' company_pays: description: Whether the company pays for self-signup type: - boolean - 'null' olumo_token: description: OLUMO token for the company type: - string - 'null' apn_bundle: description: APN bundle for the company type: - string - 'null' ibi_bundle: description: IBI bundle for the company type: - string - 'null' signup_url: description: Signup URL for the company type: - string - 'null' reward_points_enabled: description: Whether the reward points system is enabled type: boolean reward_points_apply_to_subtotal: description: Whether reward points apply to subtotal instead of total type: boolean reward_points_label_singular: description: Customer-facing singular label for reward points type: string reward_points_label_plural: description: Customer-facing plural label for reward points type: string mobile_app_identifier: type: - string - 'null' support_email: description: Support email for the company type: - string - 'null' country_code: type: - string - 'null' shipping: description: >- Company shipping. Possible values: Flat Country, Droplet, Free, Product-based type: - string - 'null' shipping_type: description: >- Internal shipping type. Possible values: manual, country, droplet, fluid-rates, free-shipping type: - string - 'null' allow_free_shipping: type: - boolean - 'null' email_provider: description: 'Email delivery provider. Possible values: fluid, droplet' type: - string - 'null' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````