> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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. # Send an email > An email, sent from the company's own sending address. Needs `outbound_messages.email`. ## OpenAPI ````yaml /api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/email openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Messages version: 2026-10 description: >- Send email, SMS, WhatsApp, push notifications and Flow messages to your members, customers and contacts, and see whether they were delivered. Every message goes out from your company's own identities: email from your company's sending address (Amazon SES), SMS from your registered number (Twilio). Fluid never falls back to a shared sender. If a channel isn't set up yet, the request is refused with a clear `code` and a `setup` block saying what's left and where to finish it. Name the recipient with exactly one of `to` (an address), `contact_id`, `customer_id` or `member_id`. Customers and members are the same people. Push, preferred and Flow take `member_id` only. To message someone inside Flow, use `POST /api/company/v2026-10/messages/flow`, or Flow's own messaging API (`POST /api/v1/messaging/conversations` and `POST /api/v1/messaging/conversations/{id}/messages`). Every send, accepted or refused, is kept with its delivery events, so `GET /api/company/v2026-10/messages/{id}` shows what happened. Delivery outcomes also teach Fluid about the address: a delivery marks it verified, and a hard bounce, complaint, invalid number or unsubscribe marks it as no longer usable. Sign in as an admin of your company, or use a company API token, a droplet token holding the opt-in `messaging` scope, or a bot token (`bearer_auth`). Each channel needs its own permission: `outbound_messages.email`, `.sms`, `.whatsapp`, `.push` or `.flow`; reading a message needs `outbound_messages.view`. A bot's send is a `message_customer` action (`GET /api/company/v2026-10/bot-action-classes`), so its owner's mode for messaging people decides whether it waits for approval, and the send rules apply as to any other sender. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: - bearer_auth: [] tags: - name: outbound-messages description: Send messages to members, customers and contacts, and track delivery. x-fluid-section: Messaging - name: contact-methods description: Every way to reach a member or contact, and a member's devices. x-fluid-section: Messaging - name: flow-senders description: >- Who apps post Flow messages as: each app's own sender, and the people who let an app send as them. x-fluid-section: Messaging - name: devices description: >- A person's phones and desktop apps, desktop presence, and signing a device out. x-fluid-section: Messaging paths: /api/company/v2026-10/messages/email: post: tags: - outbound-messages summary: Send an email description: >- An email, sent from the company's own sending address. Needs `outbound_messages.email`. operationId: companyMessagesSendEmail parameters: - name: Idempotency-Key in: header required: false schema: type: string description: Use this or `idempotency_key` in the body. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EmailBody' example: member_id: 0199c2d4-8a1e-7b35-9f02-6d4e1a7c3b58 message_type: transactional idempotency_key: order-104882-shipped subject: Your order 104882 has shipped html: >-

Hi Jordan, your order 104882 is on its way. Track it at https://shop.example.com/orders/104882.

text: >- Hi Jordan, your order 104882 is on its way. Track it at https://shop.example.com/orders/104882. reply_to: support@shop.example.com responses: '200': description: >- A repeat of an earlier request with the same idempotency key; the first message is returned and nothing is sent again. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' example: message: id: 019a1123-4b5c-7d6e-8f90-a1b2c3d4e5f6 channel: email message_type: transactional status: delivered refusal_code: null provider: ses provider_message_id: 0100019a11234c5d-7e8f9a0b-1c2d-4e3f-8a5b-6c7d8e9f0a1b-000000 recipient: member_id: 0199c2d4-8a1e-7b35-9f02-6d4e1a7c3b58 contact_id: null contact_method_id: 0199c2d5-1f3a-7c48-b6e1-9d2a4f7e8c13 conversation_id: null created_at: '2026-10-23T14:05:12Z' updated_at: '2026-10-23T14:05:16Z' events: - status: accepted detail: null occurred_at: '2026-10-23T14:05:12Z' - status: sent detail: null occurred_at: '2026-10-23T14:05:13Z' - status: delivered detail: null occurred_at: '2026-10-23T14:05:16Z' send_at: null status: 200 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-10-23T14:05:12Z' '202': description: >- Accepted. Fluid kept the message and started delivering it; follow its status with GET /messages/{id}. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' example: message: id: 019a1123-4b5c-7d6e-8f90-a1b2c3d4e5f6 channel: email message_type: transactional status: accepted refusal_code: null provider: ses provider_message_id: null recipient: member_id: 0199c2d4-8a1e-7b35-9f02-6d4e1a7c3b58 contact_id: null contact_method_id: 0199c2d5-1f3a-7c48-b6e1-9d2a4f7e8c13 conversation_id: null created_at: '2026-10-23T14:05:12Z' updated_at: '2026-10-23T14:05:12Z' events: - status: accepted detail: null occurred_at: '2026-10-23T14:05:12Z' send_at: null status: 202 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-10-23T14:05:12Z' '400': description: No idempotency key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Not signed in. content: application/json: schema: $ref: '#/components/schemas/LegacyError' '403': description: The caller lacks the channel's permission or isn't a company admin. content: application/json: schema: $ref: '#/components/schemas/LegacyError' '422': description: >- Refused: invalid parameters (`ErrorResponse`), or a channel, recipient or content refusal (`RefusalResponse`). content: application/json: schema: anyOf: - $ref: '#/components/schemas/RefusalResponse' - $ref: '#/components/schemas/ErrorResponse' examples: email_sender_not_configured: summary: Email isn't set up value: error: code: email_sender_not_configured message: >- This company hasn't finished setting up email sending yet. channel: email setup: status: not_configured next_step: >- Finish connecting the company's sending address in Settings > Communications. setup_url: /settings/communications status: 422 meta: request_uuid: 00000000-0000-0000-0000-000000000000 timestamp: '2026-10-23T12:00:00Z' channel_disabled: summary: The API isn't switched on value: error: code: channel_disabled message: >- The company messages API isn't switched on for this company yet. channel: email status: 422 meta: request_uuid: 00000000-0000-0000-0000-000000000000 timestamp: '2026-10-23T12:00:00Z' components: schemas: EmailBody: type: object additionalProperties: false required: - subject description: An email, sent from the company's own sending address. properties: to: type: string description: >- An email address (email) or an E.164 phone number (sms, whatsapp). Use this or one of the ids. contact_id: type: string description: >- A contact's id or uuid. Fluid uses the contact's best email or phone for the channel. customer_id: type: string description: >- A customer's id, as the customers API returns it. Customers and members are the same people. member_id: type: string format: uuid description: A member's uuid. message_type: type: string enum: - transactional - marketing default: transactional description: '`marketing` needs the recipient''s marketing consent for the channel.' idempotency_key: type: string maxLength: 200 description: >- A key you choose. Sending again with the same key answers with the first message instead of sending twice. You can send it as the `Idempotency-Key` header instead. subject: type: string minLength: 1 maxLength: 998 html: type: string description: The HTML body. Send html, text or both. text: type: string description: The plain-text body. reply_to: type: string description: An address replies go to. no_queue: type: boolean default: false description: >- A marketing message asked for during the recipient's quiet hours (21:00 to 08:00 in their time zone by default) waits and goes out when they end. Pass true to have it refused as `quiet_hours` with `send_at` instead. MessageResponse: type: object required: - message - status - meta properties: message: $ref: '#/components/schemas/OutboundMessage' status: type: integer meta: $ref: '#/components/schemas/Meta' ErrorResponse: type: object required: - error - status - meta properties: error: type: object required: - message properties: message: type: string details: type: object additionalProperties: true status: type: integer meta: $ref: '#/components/schemas/Meta' LegacyError: description: The error body an authorization refusal answers with. type: object additionalProperties: true RefusalResponse: type: object required: - error - status - meta properties: error: $ref: '#/components/schemas/Refusal' status: type: integer meta: $ref: '#/components/schemas/Meta' OutboundMessage: type: object additionalProperties: false description: A message sent through this API. The address itself is never returned. required: - id - channel - message_type - status - refusal_code - provider - provider_message_id - recipient - conversation_id - created_at - updated_at - events - send_at properties: id: type: string format: uuid channel: type: string enum: - email - sms - whatsapp - push - flow message_type: type: string enum: - transactional - marketing status: type: string enum: - accepted - scheduled - sent - delivered - failed - refused description: >- accepted: Fluid took it. sent: the provider accepted it. delivered: it reached the recipient. failed: it didn't and won't. refused: Fluid didn't send it. `scheduled`: a marketing message held for the recipient's quiet hours; it goes out at send_at. refusal_code: type: - string - 'null' provider: type: - string - 'null' description: ses, twilio, expo or flow. provider_message_id: type: - string - 'null' recipient: type: object additionalProperties: false required: - member_id - contact_id - contact_method_id properties: member_id: type: - string - 'null' contact_id: type: - integer - 'null' contact_method_id: type: - string - 'null' conversation_id: type: - string - 'null' description: For Flow messages, the conversation it was posted in. created_at: type: string format: date-time updated_at: type: string format: date-time events: type: array items: $ref: '#/components/schemas/MessageEvent' send_at: type: - string - 'null' format: date-time description: When a scheduled message goes out. Meta: type: object description: Response metadata. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' timestamp: type: string format: date-time Refusal: type: object description: Why Fluid didn't send. The same shape for every channel. required: - code - message - channel additionalProperties: false properties: code: type: string description: >- Setup: `email_sender_not_configured`, `sms_not_registered`, `whatsapp_not_configured`, `push_no_devices`, `channel_disabled`. Recipient: `recipient_not_found`, `recipient_ambiguous`, `no_contact_method`, `contact_method_invalid`, `consent_required`, `opted_out`, `invalid_address`, `address_not_allowed`, `content_required`, `no_reachable_channel`, `idempotency_key_reused`, `queue_failed`, `bot_not_found`, `sender_required`. Flow sender: `bot_not_authorized`, `sender_not_authorized`, `send_as_not_found`, `sender_ambiguous`, `app_sender_disabled`, `app_sender_unavailable`. Send rules (marketing only): `quiet_hours` (with `send_at`, when you passed no_queue), `frequency_capped` (with `next_allowed_at`), `promotional_mail_unavailable` (marketing email until Fluid's promotional sending path is ready). message: type: string description: A plain-English explanation. channel: type: string description: >- The channel that refused: email, sms, whatsapp, push, flow or preferred. message_id: type: string format: uuid description: The refused message Fluid kept, when it kept one. setup: type: object additionalProperties: true description: >- Present when the company has setup to finish. `status` says how far along it is (for SMS: not_started, brand_pending, campaign_pending, number_pending, rejected or approved_no_number), `next_step` what to do, `setup_url` the Admin page. For preferred, `tried` lists each channel tried and why it was skipped. properties: status: type: string next_step: type: string setup_url: type: string tried: type: array items: type: object additionalProperties: false required: - channel - code properties: channel: type: string code: type: string send_at: type: string format: date-time description: 'With quiet_hours: when the message may go.' next_allowed_at: type: string format: date-time description: >- With frequency_capped: when the next marketing message on this channel may go to this person. MessageEvent: type: object additionalProperties: false required: - status - detail - occurred_at properties: status: type: string enum: - accepted - scheduled - sent - delivered - failed - refused detail: type: - string - 'null' description: >- Why, for failed and refused events (for example bounced, unsubscribed, sms_not_registered). occurred_at: type: string format: date-time securitySchemes: bearer_auth: type: http scheme: bearer description: An admin session, company API token, droplet token or bot token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.