> ## 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. # Events > Manage your company's events: set their dates, time zone, media, countries and reminders, then duplicate, activate or delete them from the list. Use the **Events** screen to create and manage your company's events. Each event has a title, a description and dates in a time zone you choose, and it can have media, a web link and a location. ## Where to find it In the admin sidebar, under **Tools**, select **Events**. To open this screen, your role needs **View only** or **Full access** for **Events**. To create, edit, duplicate or delete events, or send notifications, it needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Events** is in the **Tools & Messaging** card. Open the card and set access from the **Events** area's menu, not the card's. ## What's on the screen The **Create Event** button is at the top of the page. Below it is the list of events. A banner above the list offers the new Events table, which keeps your place in the list as you move around the admin: click **Try it** to use it, or **Switch back** to return. ### Events list * The **All**, **Active**, **Draft** and **Out of Date** tabs filter the list by status. **Active** shows active events that haven't ended, **Draft** shows inactive events, and **Out of Date** shows active events that have ended. * Use the search box to find events by title. * Use the sort menu to sort by **Title** or **Start**, **Ascending** or **Descending**. Until you choose, the list is sorted by title, A to Z. * Click the filter icon to open **Filters**. Choose a **Country** to show only the events whose **Available Countries** include it, then click **Apply Filters**. While the filter is on, a **1 Filter Applied** label shows. To clear the filter, click the × on that label, or click **Reset All** in **Filters**. The list has these columns: * **Title**: the event's title. * **Status**: **Active**, **Draft** or **Out of Date**, as in the tabs. * **Notification**: **On** or **Off**, matching the event's **Event Notifications** switch. * **Start** and **End**: when the event starts and ends, in the event's time zone. Click an event to open it. Each row's actions menu has **Edit**, **Duplicate** and **Delete**. When you select rows, the table header has a menu that changes their status, labeled with the count, such as **Set 3 events as active** and **Set 3 events as draft**. ### Event page The event page opens when you click **Create Event** or an event in the list. A new event's page is titled **Create New Event**. A saved event's page is titled **Edit Event**. The main card holds the event's details: * **Title**: required. * **Media**: images for the event. Click **Upload Media**, or **Add More Media** once the event has images, to open the file picker. You can add up to 10 images at a time, and each can be up to 10 MB. To remove an image, point to it and click the × in its corner. * **Time Zone**: required. The dates and times you enter are in this time zone. A new event is set to UTC until you change it. * **URL**: a web address for the event, such as a link to an online meeting. Enter the full address, for example `https://meet.example.com/spring-launch`. * **Location**: where the event takes place. * **Start Date** and **End Date**: required. **Start Time** and **End Time** are optional. Without a start time, the event starts at the beginning of its start date. Without an end time, it ends at the end of its end date. * **Description**: required. The **Settings** card: * **Available Countries**: the countries the event is available in. Choose from your company's countries. * **Event Notifications**: a switch, on by default. When it's on, Fluid sends a reminder to reps in the event's **Available Countries** about an hour before an active event starts. * **Status**: **Active** or **Inactive**. A new event starts as **Active**. In the list, an inactive event shows as **Draft**. The **Event Preview** card shows the event as you fill in the form, with its start and end, a status (**Upcoming**, **In Progress** or **Concluded**), its URL and its location. ## Tasks ### Create an event On the **Events** screen, click **Create Event**. Enter a **Title** and a **Description**. Choose the **Time Zone**, then set the **Start Date** and **End Date**, and the times if you need them. Add **Media**, a **URL** and a **Location** if you want them. Choose the **Available Countries**. Turn off **Event Notifications** if you don't want the reminder. To save the event without making it active, set **Status** to **Inactive**. Click **Create Event**. A confirmation message appears and the event's page opens. ### Edit an event In the list, click the event, or choose **Edit** from its actions menu. Change the fields you need. **Save** is grayed out until you change something. To undo your changes, click **Cancel**. Click **Save**. A confirmation message appears and you stay on the event's page. ### Activate events or set them as draft In the list, select the rows of the events you want to change. Open the menu in the table header and choose **Set 3 events as active** or **Set 3 events as draft**. The number matches the rows you selected. You can also open an event, change its **Status**, and click **Save**. ### Duplicate an event In the list, choose **Duplicate** from the event's actions menu. The copy has the same details, countries and images, and its title ends in `(copy)`. It's saved as a draft. When it's ready, open it, set **Status** to **Active**, and click **Save**. ### Send a notification about an event Use **Send Notification** only for news meant for all your reps and admins. It notifies every active rep and admin in your company. On a saved event's page, click **Send Notification**. The **Notify Users about updates** dialog opens. Under **Send a notification to people in**, choose at least one country, then click **Send Push**. After a notification goes out, **Send Push** stays grayed out for 5 minutes. ### Delete an event In the list, click the event. Click **Delete** at the top of the page. In the **Delete Event?** dialog, click **Delete**. You return to the events list. You can also choose **Delete** from an event's actions menu in the list. Deleting an event can't be undone. If you close the **Delete Event?** dialog without deleting, reload the page before you delete another event from the list. In the mobile app's tab editor, the **Calendar** widget shows your active events. To add it to a tab, see [Home Tabs](/help/admin/mobile/home). ## Frequently asked questions Check that **Title**, **Time Zone**, **Start Date**, **End Date** and **Description** are filled in. A description with only spaces counts as empty. The **End Date** can't be before the **Start Date**. If the event starts and ends on the same day and you set both times, the **End Time** must be after the **Start Time**. If you enter a **URL**, it must be a full web address, such as `https://meet.example.com/spring-launch`. **Draft** means the event's **Status** is **Inactive**. To make it active, open it, set **Status** to **Active**, and click **Save**. **Out of Date** means the event is active and its end has passed. Your role can view events but doesn't have **Full access** for **Events**. Without it, you can open events, but there's no **Save** button. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Tools](/help/admin/tools) * [Announcements](/help/admin/announcements) * [Home Tabs](/help/admin/mobile/home) * [Roles](/help/admin/settings/roles) * [Mobile app](/help/mobile) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.