> ## 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. # Catchups > Turn Catchup types on or off, from abandoned carts and overdue tasks to new media and leaderboard changes. Catchups are follow-up suggestions for your affiliates. Use this screen to choose which types are on for your whole company. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Company**, select **Catchups**. ## What's on the screen The screen groups its switches into cards. For a new company, every switch starts off. The descriptions below mostly follow the screen's own text. For **Last Order Seven Days Ago** and **New Purchase**, they're more exact than the text on the screen. ### Orders & Subscriptions | Switch | Description | | - | - | | **Cart Abandoned** | A contact abandons their cart with items left inside. | | **Enrolled** | A contact creates a new enrollment. | | **Multiple Orders But No Subscription** | A contact repeatedly orders a product without subscribing. | | **Last Order Seven Days Ago** | A contact placed an order 7 days ago. Subscription orders don't count. | | **Last Affiliate Order Ten Days Ago** | An affiliate's order was placed 10 days ago. | | **Smart Link Share But No Order** | A SmartLink was sent 2 days ago but no order followed. | ### Activity | Switch | Description | | - | - | | **Recent Web Activity** | A contact views a shared page (daily summary). | | **Video Viewed** | A contact starts a video but doesn't finish watching. | | **New Product** | A new product is added and a contact has not viewed or purchased it. | | **New Media Added** | You add new media that should be shared with a contact. | | **New Training Material** | New training material is added. | | **New Trending Media** | Media is tagged as trending and is ready to be shared with a contact. | | **New Reaction on Media** | A contact reacts to shared media. | | **Review on Product** | A contact writes a review that can be shared. | ### Messages & Tasks | Switch | Description | | - | - | | **Overdue Task** | An affiliate's task is overdue. | | **Unresolved WebChat** | A web chat message to an affiliate is unanswered. | | **Unresolved Popup Chat** | A message from the pop-up feature is unresolved. | | **Unresolved Media Comment** | A contact comments on media an affiliate shared and the comment remains unresolved. | | **Unread Message** | Affiliates have unread company or contact messages (daily summary). | | **Upcoming Event** | One of your company's events starts within the next 2 days. | ### Groups | Switch | Description | | - | - | | **No Group Assigned** | A contact has not been assigned to any group. | | **Group Update Threshold Reached** | A contact's group hasn't been updated in over 60 days. | | **New Leader on LeaderBoard** | A new affiliate takes the top spot on the leaderboard. | ### Other | Switch | Description | | - | - | | **New Purchase** | A contact places their first order. The Catchup goes to the affiliate the order is credited to. | | **New Purchase of Lead** | A new lead is purchased. | ### Custom This card has no switches. Your developers can create custom Catchups. The card's **Custom Catchups Documentation** button opens the [Fluid API overview](/api/overview), the general starting point for developers. ## Turn a Catchup on or off Catchups are grouped into cards by topic, such as **Orders & Subscriptions**, **Activity** and **Groups**. Find the card that holds the one you want. Click the switch next to the Catchup's name. The change saves right away, and you see **Catch-Up setting updated successfully.** This screen has no save button. If a change fails, you see **Failed to update catch-up setting** and the reason, and the switch returns to its saved position. ## FAQ No. These switches apply to your whole company. Each Catchup type has one on/off switch, with no role, user, or timing options. Your role has **View only** access to **CatchUp**, so the switches and the **Custom Catchups Documentation** button are grayed out. Ask an admin who manages roles to set the **CatchUp** area to **Full access** on your role's **Permissions** tab. Use the area's own menu, in the **Settings** card, not the card's menu. See [Roles](/help/admin/settings/roles). The **Catchups** item appears only if your role has the **CatchUp** area, in the **Settings** card, set to at least **View only**. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Settings](/help/admin/settings) * [Roles](/help/admin/settings/roles)