> ## 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. # Write a site file > Creates the file, or replaces its content. Send the `version` of the file you read to refuse the write with 409 if the file changed or was removed since, or `must_not_exist` to create a file only if the path is free; without either the write replaces whatever is there, so the last write wins. The check and the write are one step, so a write that loses a race changes nothing. A page's file must already exist; add the page first. Writing `config/menus.json` replaces all of the site's menus, writing `config/pages.json` adds, changes and removes pages to match it and sets the site's default layout (a page added this way starts with an empty file), writing `config/settings.json` replaces its settings, and writing `config/access.json` replaces the site's draft access declaration, the list of the member fields and scopes the site uses. The declaration is a draft until the site is published, and publishing the site publishes it together with the settings. A published declaration grants no access yet. Layouts, sections, snippets and pages are saved as drafts until the site is published. Assets must be css, js, json, txt or html text files. ## OpenAPI ````yaml /api-reference/member-sites-v2026-10.yaml put /api/member/v2026-10/sites/{site_id}/files/{path} openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Sites description: > The authenticated member's own sites: list, create, read, change, delete, publish and copy, list a site's versions and restore one, with the files and pages that make up each site, and the branch a member makes to try a change to a published site. The credential alone determines the member and company; a site and a page are identified by their public ids, never by a numeric id. A member can read and change only the sites they own. Any other id, and any id of a site in another company, returns 404. These operations take a bearer only, the site menu, the site removals and the share-target search included. On the same-origin cookie mount, a request with a valid member session is refused with `403`, with or without an `X-Fluid-Member-Site` header, because a script on the company's storefront shares that origin and would otherwise act as the visiting member, so no cookie path to them can be kept from it; a request with a missing or unusable session is refused with `401` first, as on every cookie-mount route. A page that draws the account menu holds the member's bearer and sends it itself. The draft preview operations show the member's own site as its builder sees it before it is published. They answer with a page's HTML or a file's text rather than the JSON envelope, and every response of theirs, a refusal included, carries the frame's sandbox policy and is `private, no-store` and `noindex`. See the `site-preview` tag. Every operation returns 404 while member sites are not enabled for the member's company (the `MEMBER_SITES` company feature). A credential that is refused is still refused with 401 or 403 first, so a refused credential never learns whether the feature is enabled. **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: sites x-fluid-section: Members description: >- The signed-in member's own sites, with publishing, copying and optimistic locking. - name: site-branches x-fluid-section: Members description: >- The branch of one of the member's published sites, a private copy of the site that only its owner and company admins can open, with a preview of its own, where a change can be tried without touching the site. - name: site-files x-fluid-section: Members description: >- The files of one of the member's sites (layouts, sections, snippets, assets, page content, settings and menus), addressed by theme-style path. - name: site-shares x-fluid-section: Members description: >- Who one of the member's sites is shared with, a named member, the member's downline or a segment of the company's members, each with a view or copy permission. - name: site-pages x-fluid-section: Members description: >- The pages of one of the member's sites, each with the template that holds its content. - name: site-preview x-fluid-section: Members description: >- The draft of one of the member's own sites, rendered as it will be served once published, for the builder's own tools. - name: site-menu x-fluid-section: Members description: >- The member's account menu, grouped into the company's sites, the sites they built, the sites shared with them and the sites they removed. - name: site-removals x-fluid-section: Members description: >- Taking a site out of the member's own account menu, and putting it back. A removal changes nothing for the site's owner or for anyone else. - name: site-pins x-fluid-section: Members description: >- Pinning sites to the member's own account menu, in an order the member chooses. A pin changes nothing for the site's owner or for anyone else. - name: site-home x-fluid-section: Members description: >- The site the member chooses as their home, the one their account opens on. A home changes nothing for the site's owner or for anyone else. - name: site-share-targets x-fluid-section: Members description: >- Whom the member may share a site with, inside the reach their company's messaging policy gives them. paths: /api/member/v2026-10/sites/{site_id}/files/{path}: parameters: - $ref: '#/components/parameters/SiteIdPath' - $ref: '#/components/parameters/FilePath' put: tags: - site-files summary: Write a site file description: >- Creates the file, or replaces its content. Send the `version` of the file you read to refuse the write with 409 if the file changed or was removed since, or `must_not_exist` to create a file only if the path is free; without either the write replaces whatever is there, so the last write wins. The check and the write are one step, so a write that loses a race changes nothing. A page's file must already exist; add the page first. Writing `config/menus.json` replaces all of the site's menus, writing `config/pages.json` adds, changes and removes pages to match it and sets the site's default layout (a page added this way starts with an empty file), writing `config/settings.json` replaces its settings, and writing `config/access.json` replaces the site's draft access declaration, the list of the member fields and scopes the site uses. The declaration is a draft until the site is published, and publishing the site publishes it together with the settings. A published declaration grants no access yet. Layouts, sections, snippets and pages are saved as drafts until the site is published. Assets must be css, js, json, txt or html text files. operationId: member_site_files_update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SiteFileWrite' example: content: '{{ content_for_layout }}' responses: '200': description: The saved file, whether it was created or replaced. content: application/json: schema: $ref: '#/components/schemas/SiteFileEnvelope' example: status: 200 data: path: layouts/site.liquid content: '{{ content_for_layout }}' lock_version: null version: >- 4c4127c0f28a648e32ccb71b3b6d1c7cf4c8c8cf8d4459c25a14dfab782049de meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-09-30T15:08:21Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/ReadOnlyCredential' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': description: >- A missing or invalid body, `version` sent with `must_not_exist` or `lock_version`, a path that is none of the supported ones, an asset that is not a text file or is empty, settings that are not a JSON object, menus that are not a valid document, or a template that is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: parameters: SiteIdPath: name: site_id in: path required: true description: Public id of one of the member's sites. schema: type: string format: uuid FilePath: name: path in: path required: true description: >- The theme-style path of the file, with its slash: `layouts/.liquid`, `sections/.liquid`, `snippets/.liquid`, `pages/.liquid` (`pages/index.liquid` for the home page), `assets/` (a css, js, json, txt or html file), `config/settings.json`, `config/menus.json`, `config/pages.json` or `config/access.json`. Names use lowercase letters, digits, hyphens and underscores, with no subfolders. Any other path is refused with 422. schema: type: string pattern: ^.+$ schemas: SiteFileWrite: type: object description: The content of a file. The path is in the URL. additionalProperties: false properties: content: type: string pattern: ^[^\u0000]*$ description: >- The whole new content of the file. An asset must not be empty. `config/settings.json` takes a JSON object, and `config/menus.json` a JSON document of menus, `config/pages.json` a JSON document of the site's default layout and page settings, and `config/access.json` a JSON object whose `uses` key lists what the site uses, which is refused with 422 when it is not valid. lock_version: type: integer maximum: 2147483647 minimum: 0 description: >- The `lock_version` of `config/settings.json` the caller last read. The write is refused with 409 if the settings changed since. Ignored for every other file. Send either this or `version`, not both. version: type: string maxLength: 255 pattern: ^[^\u0000]*$ description: >- The `version` of the file the caller last read. The write is refused with 409 if the file has changed or been removed since, and nothing is written. For `config/settings.json` it is the `lock_version` as a string, and for `config/menus.json`, `config/pages.json` and `config/access.json` the digest of the document. Without `version` or `must_not_exist`, the write replaces whatever is at the path. Cannot be sent with `must_not_exist` or `lock_version`. must_not_exist: type: boolean description: >- Send `true` to create the file only if the path holds none. The write is refused with 409 if a file is already there, so a file another writer created since the caller listed the files is not replaced. `config/settings.json`, `config/menus.json` and `config/pages.json` always exist, so it is always refused for them. `config/access.json` exists only once it is written, so it is refused for it only when the site already has one. Cannot be sent with `version`. required: - content SiteFileEnvelope: type: object description: One site file. properties: status: type: integer description: HTTP status code (mirrors the response status line). data: $ref: '#/components/schemas/SiteFile' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - data - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object description: The error message and field-keyed details. properties: message: type: string description: Human-readable error message. details: type: object description: >- Machine-readable details, keyed by field where a field is at fault. additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SiteFile: type: object description: One file of a site. additionalProperties: false properties: path: type: string description: The theme-style path of the file, such as `layouts/site.liquid`. content: type: string description: >- The file's content. `config/settings.json`, `config/menus.json`, `config/pages.json` and `config/access.json` hold JSON documents. lock_version: type: - integer - 'null' minimum: 0 maximum: 2147483647 description: >- The version of the site's settings, for `config/settings.json` only. Send it back as `lock_version` when writing the settings. It also changes when a page of the site is added, changed or removed, and when `config/menus.json` is written, so read the settings again before a versioned write. Null for every other file; they are versioned by `version`. version: type: string description: >- The version of the file, to send back as `version` when writing it (the request body) or removing it (the query parameter), so the change is refused with 409 if the file changed since. For an asset it is a digest of the content. For a layout, section, snippet or page file it is a digest of the draft content and of the published copy, so a publish changes it too: read the files again after publishing. For `config/menus.json`, `config/pages.json` and `config/access.json` it is a digest of the document. For `config/settings.json` it is the `lock_version` as a string, which also changes when a page is added, changed or removed and when `config/menus.json` is written. Treat it as opaque. required: - path - content - lock_version - version 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 responses: Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' ReadOnlyCredential: description: >- The valid member credential is read-only (a member or portal JWT), or belongs to a sandbox test company that cannot be reached now, because sandbox access is turned off for its live company or the live company was deleted. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: >- No site of the member's has this id, the site has no such file or page, or member sites are not enabled for the member's company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Conflict: description: >- The site, its settings, the page or the file changed since it was read, or a file to be created already exists. Read it again and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' 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, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session and portal JWTs are read-only and are refused with 403 on every write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.