> ## 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. # Push notifications vs SMS: mastering multi-channel communication > Choose between push notifications and SMS for each message you send your team, and write messages people act on. Good communication keeps a direct selling team moving. Push notifications and SMS each have a job. This guide helps you choose the right channel for each message and write messages that get read. ## Push notifications A push notification is a tap on the shoulder: easy to notice, and easy to act on. Used well, push turns passive app users into active participants. ### What push does well * **Low cost at scale.** Push notifications don't carry per-message carrier fees the way SMS does. * **Targeting.** Reach the right people. In Fluid, a push notification about an [announcement](/help/admin/announcements) goes to the countries you choose, and the announcement itself can be limited to certain ranks. A notification about an [event](/help/admin/events) goes to every active rep and admin, so save it for company-wide news. * **Straight into the app.** A tap takes people right to what you want them to see. Make your push notifications feel like a conversation, not a broadcast. **Get the timing right.** Send when your audience is most likely to engage. Test windows such as early morning, lunchtime and early evening, in your team's time zones, and keep the ones that work. **Write messages that get action.** Combine urgency with value. For example: * *Sarah, you're just 2 sales away from Silver rank! Tap to see who's ready to buy.* * *Flash sale: your team's favorite products at 40% off, for the next 2 hours only.* ## SMS Push excels at engagement. SMS is the channel to use when a message absolutely has to arrive. Use it for: | Critical updates | Time-sensitive information | Security and verification | | - | - | - | | System outages | Flash sales | Sign-in codes | | Emergency announcements | Limited-time offers | Account alerts | | Company-wide alerts | Event reminders | Password resets | SMS costs money for every message, so use it carefully: 1. **Target carefully.** Send only to the people who need the message. 2. **Combine messages.** Group updates into a daily or weekly digest where you can. 3. **Time it well.** Track delivery and adjust your sending times. ## Use both together Know when to use each channel. **Push notifications** for everyday engagement and motivation: * Achievement celebrations * Performance updates * Training reminders * Progress toward personal goals * Team recognition **SMS** for business-critical messages: * System alerts * Security verification * Flash sale announcements * Event reminders * Account updates Using push for day-to-day updates and saving SMS for critical messages keeps costs down and keeps your SMS messages meaningful. ## Your action plan 1. **Review.** Look at how you communicate today, and find where to improve. 2. **Plan.** Decide which channel each kind of message uses. 3. **Measure and adjust.** Track the results, and keep refining. Start small, test thoroughly, and scale what works. The best communication strategy grows with your team. ## Frequently asked questions **Choose the channel** | Message | Push notification | SMS | Notes | | - | - | - | - | | Achievement updates | Preferred | Avoid | Celebrate right away | | Sales milestones | Preferred | Avoid | Link to the details in the app | | Training reminders | Preferred | Avoid | Send while people are active | | Flash sales | Primary | Backup | Use both for important promotions | | System outages | Avoid | Required | SMS gets through | | Security alerts | Avoid | Required | For verification codes | | Event reminders | Primary | Optional | Push first, SMS on the day | | Password resets | Avoid | Required | For security | | Team recognition | Preferred | Avoid | Make it easy to share | **Write better push notifications** * Keep them under about 125 characters. * Include a clear call to action. * Use one or two emojis at most. * Personalize them. * Link to the right place in the app. Examples: * *Congrats Sarah! You've hit 80% of your monthly goal. Tap for your final-sprint plan.* * *Next 3 hours: 40% off bestsellers. Your team's favorites are in stock.* * *5 team members just ranked up! See their winning strategies.* **Plan your SMS messages** Before you send, decide how urgent it is, choose the audience carefully, check the timing, and make sure it really needs to be a text. Then follow a simple structure: ```text theme={null} [Your company] ALERT: Flash sale starts now. Top 10 products at 50% off. Shop by 11:59 PM ET: [link] Questions? Reply HELP ``` **Time and pace your messages** | Message | Best time | How often | | - | - | - | | Achievements | The same day | Once per achievement | | Sales alerts | Late morning to early afternoon | Twice a week at most | | Updates | Morning or early afternoon | Three times a week at most | | Reminders | A day before | As needed | Track open and click rates by time and type of message, and test different formats. Avoid generic messages, too many messages, vague calls to action, poor timing and too many emojis. See [Use both together](#use-both-together). ## Related pages * [Announcements](/help/admin/announcements) * [Events](/help/admin/events) * [Messaging](/help/admin/messages) * [App engagement](/help/playbook/maximizing-app-engagement-your-strategy-guide) ## Get help Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](/help/getting-help) page lists what to include in your request. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.