> ## 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. # Publish, restore, copy and take down a member site > Keep a member site's draft apart from what members see, publish it with the CLI or the API, restore an earlier version, copy a site, try a change on a branch, and understand take-down and deletion. A member site has a draft and a published copy. You build the draft and members see the published copy. This page covers how to publish, how to go back to an earlier version, how to copy a site or try a change on a branch, and what happens when a company takes a site down or you delete it. ## Know draft and published A site is in one of three states: | Status | What it means | | - | - | | `draft` | The site is new. Members can't open it, its owner included | | `published` | Members who are allowed to open it see its published pages | | `taken_down` | A company admin took it down. No one can open it, and its owner can't publish it again | Within a published site, most files have two copies. Members see only the published copy, and a file that was never published is missing to them. These have a draft: the content of layouts, sections, snippets and pages, `config/settings.json` and, on a member's site, `config/access.json`. A publish replaces the published copies with the drafts. Some changes have no draft and are live as soon as you write them: assets, `config/menus.json`, page rows and the site's default layout. [Pages and menus](https://docs.fluid.app/member-sites/pages-and-menus.md#know-what-is-live-at-once) lists them. A site's name, handle and visibility also take effect as soon as you save them. A site's address is built from its handle, so changing the handle changes the address. ## Preview the draft You can see a site's draft before anyone else can, whether the site is a draft or already published. * **With the CLI**, run `fluid member-site dev`. It saves each change as a draft and serves the draft on a local port. See [dev](https://docs.fluid.app/member-sites/cli.md#dev). * **With the API**, use the preview operations. For a member's site: [Preview the home page of a site's draft](https://docs.fluid.app/api-reference/site-preview/preview-the-home-page-of-a-sites-draft.md), [Preview a page of a site's draft](https://docs.fluid.app/api-reference/site-preview/preview-a-page-of-a-sites-draft.md) and [Read a text asset of a site's draft](https://docs.fluid.app/api-reference/site-preview/read-a-text-asset-of-a-sites-draft.md). For a company site, the operations under [Preview the home page of a company site's draft](https://docs.fluid.app/api-reference/member-site-preview/preview-the-home-page-of-a-company-sites-draft.md). A preview answers with the page's HTML or the asset's text, not the JSON envelope. It shows every page, published or not, and never falls back to the published page. It renders for no signed-in viewer, so it holds nothing of the member's. Only the site's owner sees a member's preview, and only a signed-in admin sees a company site's. Anyone else gets the same empty not-found answer as for a site that doesn't exist. Assets have no draft, so a preview serves an asset as written. ## Publish a site Publishing makes the drafts live. It is one request with no body. Publishing a site that is already published publishes its current content again. * **With the CLI**, run `fluid member-site publish` to publish what is already saved, or `fluid member-site push --publish` to push the folder and then publish once. See [publish](https://docs.fluid.app/member-sites/cli.md#publish). * **With the API**, write the files and pages first, then publish. Use [Publish a site](https://docs.fluid.app/api-reference/sites/publish-a-site.md) for a member's site and [Publish a company site](https://docs.fluid.app/api-reference/member-sites/publish-a-company-site.md) for a company's site. A publish happens in one step, so a failure leaves the site as it was. It replaces the site's `content_version` and saves a version in the site's history. * **A member publishes their own sites.** A company admin publishes the company's sites. An admin can't publish a member's site. * **A member's publish includes `config/access.json`.** A site with no draft declaration publishes none, which removes the declaration it had published. See [Declare what a member site uses](https://docs.fluid.app/member-sites/access-declarations.md#publish-change-and-remove-a-declaration). * **A taken-down site can't be published.** The request is refused. * **A conflict means the site changed while it was being published.** Nothing was published. Run the publish again. * **Page rows, assets and menus aren't part of a publish.** They have no draft. A page row's `published` flag decides whether a page is served, and a publish doesn't change it. ## Go back to an earlier version Each publish, and each restore, is saved as a version of the site. You can list the versions and put the site back to one. * [List a site's versions](https://docs.fluid.app/api-reference/sites/list-a-sites-versions.md) returns the versions, newest first. It returns 25 by default and at most 100. Company admins use [List a site's versions](https://docs.fluid.app/api-reference/member-sites/list-a-sites-versions.md), which works for any site in the company. * [Restore a site to a version](https://docs.fluid.app/api-reference/sites/restore-a-site-to-a-version.md) takes the `sha` of a version from that list. Admins use [Restore a site to a version](https://docs.fluid.app/api-reference/member-sites/restore-a-site-to-a-version.md). A restore replaces the site's files, pages, menus and settings with the version's, and publishes them. On a member's site it replaces the access declaration too, and a version with no declaration clears it. Your unpublished drafts are replaced. * **A restore keeps the site's name, handle, visibility and status, and its shares.** A site that was taken down stays taken down. * **It's all or nothing.** Either the whole version is restored or nothing changes. * **You can undo a restore.** The restore is itself saved as a version, so restore the version before it. * **A site that was never published has no history.** Listing its versions is refused. * **An admin can list and restore the versions of any site in the company**, a member's included, even though an admin can't change a member's files. * **The oldest entry in the list is not a site version.** It holds no site, and restoring it is refused. * **A restore can ask you to retry.** The site's latest change has to reach its history first. Until it does, the restore answers a conflict. Wait a moment and send it again. * **A branch has no history of its own.** The CLI has no command for versions. Use the API. ## Copy a site A copy is a new draft site with the original's published content. It holds the original's published layouts, sections, snippets, pages, settings, text assets and menus. It never holds a draft, a file that was never published or a page that isn't published, and a menu item that links to a page that wasn't copied is left out with the items below it. * **A copy is independent.** Changing or deleting either site never changes the other. The copy's `copied_from_id` names the original, and it becomes null if the original is deleted. * **A member copies a site they own, or a published site a share with `copy` permission opens to them.** A member can't copy a site an admin took down, even their own. The copy belongs to the member, is private, isn't published and counts toward the member's 25-site limit. A member's copy starts with the original's published declaration as its own draft. See [Copy a site](https://docs.fluid.app/api-reference/sites/copy-a-site.md). * **A company admin copies any site in any status**, a member's included. The copy is a new draft company site. It has no declaration, because a company site takes none, and a company has no site limit. See [Copy a member site](https://docs.fluid.app/api-reference/member-sites/copy-a-member-site.md). * **You can name the copy.** Without a name it is called "Copy of" and the original's name. Without a handle one is proposed from the name. ## Try a change on a branch A branch is a private copy of a published site that you edit and publish without touching the site members use. The API has branches. The CLI has no branch command. * **Make one with** [Branch a site](https://docs.fluid.app/api-reference/site-branches/branch-a-site.md) for a member's site, or [Branch a company site](https://docs.fluid.app/api-reference/member-site-branches/branch-a-company-site.md). The branch is cloned from the site's published content and is published at once. Nothing the site holds in draft is copied, and the site never changes. * **A site has one branch at a time.** The branch's `slug` defaults to `staging`. Delete the branch to make another. * **A branch is a site of its own.** Edit it with the files and pages operations and publish it with the publish operation, using the branch's `site_id` as the site id. * **A branch is private.** It can't be shared or made public. Only its owner and company admins can open it. It is left out of the site list and the account menu, and it counts toward a member's 25-site limit. * **Read the branch to see if it is stale.** [Read a site's branch](https://docs.fluid.app/api-reference/site-branches/read-a-sites-branch.md) says whether the site's published content has changed since the branch was made. * **Only a published site can be branched.** A draft site, a taken-down site, a branch, and a site that holds a binary asset can't. * **Nothing merges a branch back.** To keep a change, read the branch's files and write them to the site yourself, then publish the site. * **Deleting the site deletes its branch.** [Delete a site's branch](https://docs.fluid.app/api-reference/site-branches/delete-a-sites-branch.md) deletes the branch and its own site, and the original doesn't change. Admins branch company sites only. A member branches their own sites. An admin can list, read and delete the branch of any site in the company, and deleting a member's branch is moderation. See [List a site's branches](https://docs.fluid.app/api-reference/member-site-branches/list-a-sites-branches.md) and [Delete a site's branch](https://docs.fluid.app/api-reference/member-site-branches/delete-a-sites-branch.md). ## Take a site down A company admin takes a site down when it shouldn't be open: a member's site or the company's. See [Take a member site down](https://docs.fluid.app/api-reference/member-sites/take-a-member-site-down.md). * **No one can open a taken-down site.** Its status becomes `taken_down`, members get not found, and the owner can't publish it again. A branch is taken down with its site. * **The owner can still change and delete it.** A member can edit the site's files and pages, or delete it. They can't publish or copy it. * **It leaves menus.** A taken-down site isn't in its owner's account menu, and it can't be featured. A site that was already featured stays on the featured list so an admin can stop featuring it. * **Nothing puts it back up.** There is no operation that reverses a take-down. An admin can copy the site into a new company site, or delete it. * **Taking down twice changes nothing.** An admin can take down any site in the company but can't change a member's site: the owner builds it. ## Delete a site Deleting a site deletes its pages and its branch. A site that was copied from it stays: the copy's `copied_from_id` becomes null. * **A member deletes their own site**, in any status. See [Delete a site](https://docs.fluid.app/api-reference/sites/delete-a-site.md). * **A company admin deletes any site in the company.** See [Delete a member site](https://docs.fluid.app/api-reference/member-sites/delete-a-member-site.md). * **A conflict means another request is changing the site.** Send the delete again. No operation undoes a delete. To keep a site's content, [copy it](#copy-a-site) first. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.