> ## 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. > 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 (send the built folder's 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; the MCP server has no tools for logs, traffic, env vars or converting to an App, so use the fluid sites CLI for those. > 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. # Mark one site update read > Marks one row read, as View or Got it does, and answers the row and the unread count. A row already read keeps its first read time, so a repeat answers 200 with the same `read_at`. A row of another member, a cleared row, a notification that is not a site update and an unknown id are the same 404. Needs no body. Answers 404 while member sites are not enabled for the company. Bearer with write access only: a request on the cookie mount is refused with 403. ## OpenAPI ````yaml /api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/notifications/{id}/read openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Settings description: > Includes notification preferences shared across the member user's memberships. The agreements that apply to the signed-in member and their acceptance. Every operation acts as the member the bearer credential speaks for; the member and their company come from the credential alone. Acceptance here is the same record the company's login agreement check reads; it is not a checkout gate, which stays a storefront concern. **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 refuses a credential for it with `403` and the standard error envelope, before the operation runs. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: agreements description: >- The company agreements that apply to the member, their text, and the member's versioned acceptance. x-fluid-section: Settings - name: notifications description: >- The member's site-update notifications, the bell on the Passport and the apps, listed newest first, counted and marked read. x-fluid-section: Settings - name: notification-preferences description: >- Which notifications the member receives on which channel, and when not to disturb them. x-fluid-section: Settings - name: notification-devices description: >- The devices the member receives push notifications on, registered by the mobile app. x-fluid-section: Settings - name: features description: The release flags a rep's own clients read for the rep's company. x-fluid-section: Settings paths: /api/member/v2026-10/notifications/{id}/read: parameters: - name: id in: path required: true description: Public id of one of the bell's rows. schema: type: string format: uuid post: tags: - notifications summary: Mark one site update read description: >- Marks one row read, as View or Got it does, and answers the row and the unread count. A row already read keeps its first read time, so a repeat answers 200 with the same `read_at`. A row of another member, a cleared row, a notification that is not a site update and an unknown id are the same 404. Needs no body. Answers 404 while member sites are not enabled for the company. Bearer with write access only: a request on the cookie mount is refused with 403. operationId: member_notifications_read responses: '200': description: The row is read. content: application/json: schema: $ref: '#/components/schemas/SiteUpdateNotificationMarkedEnvelope' example: status: 200 data: unread_count: 2 notification: id: 0192f6d1-2b3c-7d4e-8f50-6a7b8c9d0e1f kind: site_update text: 'Spring collection is live: new bundles on the home page.' by: Pat Owner by_avatar_url: https://cdn.example.com/avatars/pat-owner.png created_at: '2026-11-10T15:08:21.000000Z' read_at: '2026-11-10T15:09:02.000000Z' site: id: 0192f6d1-1a2b-7c3d-8e4f-5a6b7c8d9e0f handle: primex-launch name: Primex Launch meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-11-10T15:10:00Z' '401': description: >- Missing credential, or a credential that is not a usable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- The valid member credential is read-only (a member JWT, or a portal JWT minted read-only); the request is on the same-origin cookie mount, which never serves the bell (the Passport has its own routes); or the credential belongs to a sandbox test company that cannot be reached now. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- The bell has no row with this id for the member, or member sites are not enabled for the member's company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: SiteUpdateNotificationMarkedEnvelope: type: object description: The answer to marking one row read. required: - status - data - meta properties: status: type: integer data: $ref: '#/components/schemas/SiteUpdateNotificationMarked' meta: $ref: '#/components/schemas/ResponseMeta' ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SiteUpdateNotificationMarked: type: object description: The answer to marking one row read. additionalProperties: false required: - unread_count - notification properties: unread_count: type: integer minimum: 0 description: How many of the bell's rows are unread after the mark. notification: $ref: '#/components/schemas/SiteUpdateNotification' ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true SiteUpdateNotification: type: object description: >- One row of the member's bell: a line posted on a member site. The text is stored with the notification, so a row outlives the update it came from. additionalProperties: false required: - id - kind - text - by - by_avatar_url - created_at - read_at - site properties: id: type: string format: uuid description: >- Public id of the notification. Send it to `POST /notifications/{id}/read`. kind: type: string enum: - site_update description: What the row is. Only site updates are listed. text: type: string maxLength: 240 description: The line that was posted. by: type: string description: >- Who posted it, as the member sees them: the author's name in the company, else their name as a user, else the company's name when the update has no author. by_avatar_url: type: - string - 'null' description: >- The author's avatar image. Null when the author has none or the update has no author. created_at: type: string format: date-time description: When the notification was created. read_at: type: - string - 'null' format: date-time description: >- When the member first read it. Null while unread; a second mark does not change it. site: description: >- The site the update was posted on. Null once the member can no longer open the site, such as a private site that was not shared with them or was taken down; the row stays listed. oneOf: - type: 'null' - $ref: '#/components/schemas/SiteUpdateNotificationSite' SiteUpdateNotificationSite: type: object description: The site a notification is about, when the member can still open it. additionalProperties: false required: - id - handle - name properties: id: type: string format: uuid description: Public id of the site. handle: type: string description: The site's URL segment. name: type: string description: The site's display name. securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.