> ## 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. > 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 where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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 — 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. # Announcements > Create announcements for your mobile app with a video, image, PDF or PowerPoint file, and send push notifications about them. Use the **Announcements** screen to post news for your reps and let them know about it with a push notification. To show announcements in your mobile app, add the **Announcements** widget to a Home tab, as described in [Home Tabs](/help/admin/mobile/home). ## Where to find it In the admin sidebar, under **Tools**, select **Announcements**. To open this screen, your role needs **View only** or **Full access** for **Announcements**. With **View only**, you can open announcements but not change them. To add, edit or delete announcements, or send notifications, your role needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Announcements** is in the **Tools & Messaging** card. Open the card and set access from the **Announcements** area's menu, not the card's. ## What's on the screen The **Add Announcement** button is at the top of the page. Below it is the list of announcements. ### Announcements list * The **All**, **Active** and **Inactive** tabs filter the list by status. * Use the search box to find an announcement. * Click the filter button to open **Filters**. Choose a **Status** (**All Statuses**, **Active** or **Inactive**, the same choice as the tabs), then click **Apply Filters**. **Reset All** clears it. The list has these columns: * **Title**: the announcement's title. * **Preview**: a thumbnail of the announcement's media, when it has one. * **Status**: **Active** or **Inactive**. * **Date Created**: the date the announcement was created. The newest announcements are listed first. Click the **Title** or **Date Created** header to sort by that column. Click an announcement to open it. Each row's actions menu has **Edit** and **Delete**. The table header has a menu for the rows you select, labeled with the count, such as **Delete 3 rows**. ### Announcement page The announcement page opens when you click **Add Announcement** or an announcement in the list. Its breadcrumb ends in **New Announcement** for a new announcement and **Edit Announcement** for a saved one. The buttons at the top of the page: * **Send Notification**: opens the push notification dialog. It's grayed out until the announcement is saved. * **Delete**: on a saved announcement only. * **Cancel**: appears when a saved announcement has changes you haven't saved. Click it to put back the saved version. * **Save**: grayed out until there's something to save. On the left is the media card, and below it the card with the text: * **Media**: on a new announcement, this is the **New Announcement Media Upload** card. Click it and choose one file in the window that opens. The card lists the supported formats, MP4, MOV, AVI, JPG, PNG, PDF, PPT and PPTX, and a maximum file size of 35MB. After you choose a file, the card shows the file's name, and **Change** lets you choose a different one. On a saved announcement, the **Preview** card shows the current media instead. * **Title**: required. * **Body**: the announcement's text, in an editor with formatting. On the right is the **Settings** card: * **Ranks**: choose one or more of your company's ranks. * **Search Engine Indexing**: **True** or **False**. A new announcement starts at **True**. * **Allow Comments**: **True** or **False**. A new announcement starts at **True**. * **Countries**: the countries where the announcement shows. Choose from your company's countries, or leave it empty to show the announcement in all countries. * **Status**: **Active** or **Inactive**. A new announcement starts as **Inactive**. Only active announcements appear in the **Announcements** widget. ## Tasks ### Create an announcement On the **Announcements** screen, click **Add Announcement**. Click the **New Announcement Media Upload** card and choose a video, image, PDF or PowerPoint file. Enter a **Title**. Add **Body** text if you want it. In the **Settings** card, choose **Ranks** and **Countries**, and set **Search Engine Indexing** and **Allow Comments**. Set **Status** to **Active** when you want the announcement to appear in the **Announcements** widget. Click **Save**. A confirmation message appears, and the page reopens as the saved announcement, where you can send a notification. **Save** stays grayed out until you've entered a **Title** and added a file. ### Edit an announcement In the list, click the announcement, or choose **Edit** from its actions menu. Change the fields you need. To replace the file, click **Edit Media** in the **Preview** card, click **Change**, and choose the new file. Click **Save**. A confirmation message appears and you stay on the announcement's page. To discard changes you haven't saved, click **Cancel** at the top of the page. ### Send a push notification In the list, click a saved announcement. Click **Send Notification**. The **Notify Users about updates** dialog opens. It sends a push notification to active, licensed users. Under **Send a notification to people in**, choose one or more countries. These are separate from the announcement's **Countries** setting. Click **Send Push**. A confirmation message appears, and the dialog lists the countries the notification went to. Click **Cancel** to close it. After a notification goes out, **Send Push** stays grayed out for 5 minutes and shows how long ago the notification was sent. Before you send a notification, set **Status** to **Active** and save your changes. The notification uses the saved announcement, and only active announcements appear in the **Announcements** widget. ### Delete an announcement In the list, choose **Delete** from the announcement's actions menu. In the **Delete announcement?** dialog, click **Delete**. To delete several announcements, select their rows and choose the delete option, such as **Delete 3 rows**, from the table header's menu. You can also open an announcement and click **Delete** at the top of the page, then **Delete** in the **Delete Announcement?** dialog. Deleting an announcement can't be undone. ## Frequently asked questions A **Title** and a file: a video, image, PDF or PowerPoint file of up to 35MB. **Body**, **Ranks** and **Countries** are optional. If you leave **Countries** empty, the announcement shows in all countries. The announcement isn't saved yet. Click **Save**. The page reopens as the saved announcement, and **Send Notification** becomes available. Choose at least one country first. If a notification for this announcement went out in the last 5 minutes, the button shows how long ago it was sent and stays grayed out until 5 minutes have passed. Your role doesn't have **Full access** for **Announcements**. With **View only**, announcements open with their fields grayed out, and **Save**, **Delete** and **Send Notification** don't appear. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Tools](/help/admin/tools) * [Home Tabs](/help/admin/mobile/home) * [Mobile app](/help/mobile) * [Roles](/help/admin/settings/roles) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.