> ## 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 confirmation link, then sign the agent in to the Fluid CLI or give it 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 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. # Deliver a scheduled message now > Make an owned scheduled message due now. The sender job normally sends it within seconds, and the scheduled-message cron recovers it if that immediate enqueue is lost. ## OpenAPI ````yaml /api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/scheduled_messages/{id}/deliver openapi: 3.1.0 info: title: Fluid Messaging v1 API description: | **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v1 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: messaging---conversations description: >- Create, list, update, and manage messaging conversations (direct, group, channel, SMS, email, and bot) as the signed-in company admin or rep. x-fluid-section: Messaging - name: messaging---scheduled-messages description: >- Schedule, update, cancel, and immediately deliver messages in a conversation as the signed-in company admin or rep. x-fluid-section: Messaging paths: /api/v1/messaging/conversations/{conversation_id}/scheduled_messages/{id}/deliver: post: tags: - messaging---scheduled-messages summary: Deliver a scheduled message now description: >- Make an owned scheduled message due now. The sender job normally sends it within seconds, and the scheduled-message cron recovers it if that immediate enqueue is lost. operationId: messaging_v1_deliver_scheduled_message parameters: - name: conversation_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MessagingScheduledMessage' example: attachments: [] body: >- Team meeting in the conference room at 9 sharp. Bring your Q3 sales numbers. conversation_id: 7731 created_at: '2026-09-16T17:45:00Z' deleted_at: null edited_at: null emoji_only_count: 0 id: 90488 mentioned_recipients: [] metadata: null pinned: false reaction: null reaction_stats: null replied_to_message: null seen_by: [] seen_by_count: 0 sender_recipient: avatar_background: 4F46E5 blocked: false blocker: false discarded_at: null first_name: Dwight id: 48217 image_url: >- https://cdn.fluid.app/avatars/dunder-mifflin/dwight-schrute.jpg last_name: Schrute pro_user: false scheduled_at: '2026-09-16T17:44:59Z' sent_at: null status: queued type: DirectMessage updated_at: '2026-09-16T17:45:00Z' '401': description: unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Scheduled messaging is unavailable for the recipient content: application/json: schema: $ref: '#/components/schemas/MessagingScheduledMessageDeleteResponse' '404': description: The scheduled message is missing or has already been claimed content: application/json: schema: anyOf: - $ref: >- #/components/schemas/MessagingScheduledMessageDeleteResponse - $ref: '#/components/schemas/NotFoundResponse' '422': description: The message delivery kind is not available content: application/json: schema: $ref: '#/components/schemas/MessagingScheduledMessageDeleteResponse' security: - bearer_auth: [] components: schemas: MessagingScheduledMessage: type: object properties: attachments: type: array items: $ref: '#/components/schemas/MessagingAttachment' body: type: string conversation_id: type: integer created_at: type: string format: date-time deleted_at: type: 'null' edited_at: type: 'null' emoji_only_count: type: - integer - 'null' id: type: integer mentioned_recipients: type: array items: $ref: '#/components/schemas/MessagingSlimmedRecipient' metadata: type: 'null' pinned: type: boolean reaction: type: 'null' reaction_stats: type: 'null' replied_to_message: type: 'null' scheduled_at: type: string format: date-time seen_by: type: array items: $ref: '#/components/schemas/MessagingNominalRecipient' seen_by_count: type: integer sender_recipient: $ref: '#/components/schemas/MessagingReducedRecipient' sent_at: type: - string - 'null' format: date-time status: type: string type: type: - string - 'null' description: >- The message type the scheduled message is sent as (for example `DirectMessage`), or null when none was given. updated_at: type: string format: date-time required: - attachments - body - conversation_id - created_at - deleted_at - edited_at - emoji_only_count - id - mentioned_recipients - metadata - pinned - reaction - reaction_stats - replied_to_message - scheduled_at - seen_by - seen_by_count - sender_recipient - sent_at - status - type - updated_at additionalProperties: false UnauthorizedResponse: type: object properties: message: type: string required: - message MessagingScheduledMessageDeleteResponse: type: object properties: message: type: string success: type: boolean required: - message - success additionalProperties: false NotFoundResponse: type: object properties: error: type: string required: - error MessagingAttachment: type: object properties: id: type: integer url: type: - string - 'null' filename: type: - string - 'null' kind: type: - string - 'null' image_url: type: - string - 'null' image_path: type: - string - 'null' content_type: type: - string - 'null' attachable_type: type: - string - 'null' attachable_id: type: - integer - 'null' metadata: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' content_size: type: - integer - 'null' thumbnail_url: type: - string - 'null' additionalProperties: false MessagingSlimmedRecipient: type: object properties: avatar_background: type: - string - 'null' blocked: type: - boolean - 'null' discarded_at: type: - string - 'null' format: date-time email: type: - string - 'null' first_name: type: - string - 'null' id: type: integer last_name: type: - string - 'null' phone: type: - string - 'null' required: - avatar_background - blocked - discarded_at - email - first_name - id - last_name - phone additionalProperties: false MessagingNominalRecipient: type: object properties: avatar_background: type: - string - 'null' first_name: type: - string - 'null' id: type: integer image_url: type: - string - 'null' last_name: type: - string - 'null' seen_at: type: - string - 'null' format: date-time required: - avatar_background - first_name - id - image_url - last_name additionalProperties: false MessagingReducedRecipient: type: object properties: avatar_background: type: - string - 'null' blocked: type: - boolean - 'null' blocker: type: - boolean - 'null' discarded_at: type: - string - 'null' format: date-time first_name: type: - string - 'null' id: type: integer image_url: type: - string - 'null' last_name: type: - string - 'null' pro_user: type: - boolean - 'null' email: type: - string - 'null' description: >- The contact's email address. Present only for contacts, not for company members. phone: type: - string - 'null' description: >- The contact's phone number. Present only for contacts, not for company members. seen_at: type: - string - 'null' format: date-time description: >- When this recipient last read the conversation. Present only in seen-by listings. required: - avatar_background - blocked - blocker - discarded_at - first_name - id - image_url - last_name - pro_user additionalProperties: false JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.