> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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. # Create a conversation > Create a conversation as yourself: a signed-in company admin or rep whose role includes the messaging update permission. You are always added as a participant. Set `conversation.type` to choose what to create: - `ChannelConversation`: a named channel. Only company admins can create one; a rep gets a 400. `recipients` is ignored. Members are you plus everyone matching `conversation.filter`. - `DirectConversation`: a one-to-one conversation with a company member or a contact. - `GroupConversation`: a named conversation with several participants. - `SmsConversation` and `EmailConversation`: a conversation with contacts over SMS or email. - `BotConversation`: a conversation with a bot. For every type except a channel, if a conversation of that type already exists with exactly the same participants, it is returned instead of a new one. A conversation stays `initiated` until its first message. Any `initiated` conversation you created with the same name is deleted first. Identify each participant in `recipients` by `uid`, the recipient ID of an existing company member or contact. A recipient given only by `email` or `phone` becomes one of your contacts, found or created; this applies only to direct, group, SMS, and email conversations. To start several conversations and send each one the same first message, send `conversations` and `message` instead of `conversation` and `recipients`. The response is then a 201 with the conversations that were created. ## OpenAPI ````yaml /api-reference/messaging-v1.yaml post /api/v1/messaging/conversations openapi: 3.1.0 info: title: Fluid Messaging v1 API 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 paths: /api/v1/messaging/conversations: post: tags: - messaging---conversations summary: Create a conversation description: >- Create a conversation as yourself: a signed-in company admin or rep whose role includes the messaging update permission. You are always added as a participant. Set `conversation.type` to choose what to create: - `ChannelConversation`: a named channel. Only company admins can create one; a rep gets a 400. `recipients` is ignored. Members are you plus everyone matching `conversation.filter`. - `DirectConversation`: a one-to-one conversation with a company member or a contact. - `GroupConversation`: a named conversation with several participants. - `SmsConversation` and `EmailConversation`: a conversation with contacts over SMS or email. - `BotConversation`: a conversation with a bot. For every type except a channel, if a conversation of that type already exists with exactly the same participants, it is returned instead of a new one. A conversation stays `initiated` until its first message. Any `initiated` conversation you created with the same name is deleted first. Identify each participant in `recipients` by `uid`, the recipient ID of an existing company member or contact. A recipient given only by `email` or `phone` becomes one of your contacts, found or created; this applies only to direct, group, SMS, and email conversations. To start several conversations and send each one the same first message, send `conversations` and `message` instead of `conversation` and `recipients`. The response is then a 201 with the conversations that were created. operationId: messaging_v1_create_conversation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MessagingConversationCreateRequest' examples: group: summary: Create a group conversation value: conversation: type: GroupConversation name: Spring launch team description: Planning the April product launch recipients: - uid: 48211 - uid: 48307 channel: summary: Create a broadcast channel for one member type value: conversation: type: ChannelConversation name: Diamond leaders description: Weekly updates for Diamond-rank leaders broadcasting: true filter: member_type_id: - 12 auto_add_recipients: true recipients: [] batch: summary: >- Start direct conversations with two contacts and send a first message value: conversations: - conversation: type: DirectConversation recipients: - email: maria.lopez@gmail.com first_name: Maria last_name: Lopez - conversation: type: DirectConversation recipients: - uid: 51930 message: body: >- Thanks for your order! Let me know if you have any questions about getting started. responses: '200': description: >- The conversation was created, or an existing conversation with the same participants was found. content: application/json: schema: $ref: '#/components/schemas/MessagingConversationSummary' example: id: 90412 type: GroupConversation kind: group name: Spring launch team description: Planning the April product launch status: initiated conversation_type: internal broadcasting: null auto_add_recipients: null announcing: false avatar_background_color: null avatar_emoji: null avatar_url: null image_url: null created_at: '2026-09-30T15:42:07Z' pinned_messages_count: 0 total_recipients: 3 unread: false pinned: false muted: false unread_messages_count: 0 scheduled_messages_count: 0 email_enabled?: false sms_enabled?: false messaging_enabled?: true draft_message: null recipients: - id: 48102 receivable_id: 7731 receivable_type: UserCompany first_name: Jordan last_name: Reyes status: active last_online: '2026-09-30T15:40:12Z' avatar_background: '#4F46E5' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 48211 receivable_id: 7802 receivable_type: UserCompany first_name: Priya last_name: Shah status: active last_online: '2026-09-29T21:03:55Z' avatar_background: '#0EA5E9' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null - id: 48307 receivable_id: 7859 receivable_type: UserCompany first_name: Marcus last_name: Bell status: active last_online: '2026-09-30T09:17:31Z' avatar_background: '#F59E0B' avatar_url: null image_url: null country_name: Canada pro_user: false blocked: false left_conversation_at: null discarded_at: null creator: id: 48102 first_name: Jordan last_name: Reyes avatar_background: '#4F46E5' image_url: null pro_user: true blocked: false blocker: false discarded_at: null '201': description: >- Batch mode (`conversations`): the conversations that were created. A conversation that could not be saved is left out. content: application/json: schema: type: array items: $ref: '#/components/schemas/MessagingConversationSummary' example: - id: 90415 type: DirectConversation kind: direct name: Maria Lopez description: null status: open conversation_type: external broadcasting: null auto_add_recipients: null announcing: false avatar_background_color: null avatar_emoji: null avatar_url: null image_url: null created_at: '2026-09-30T15:44:51Z' pinned_messages_count: 0 total_recipients: 2 unread: false pinned: false muted: false unread_messages_count: 0 scheduled_messages_count: 0 email_enabled?: true sms_enabled?: false messaging_enabled?: true draft_message: null recipients: - id: 48102 receivable_id: 7731 receivable_type: UserCompany first_name: Jordan last_name: Reyes status: active last_online: '2026-09-30T15:40:12Z' avatar_background: '#4F46E5' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 51944 receivable_id: 20318 receivable_type: Contact first_name: Maria last_name: Lopez email: maria.lopez@gmail.com phone: null avatar_background: '#10B981' avatar_url: null image_url: null country_name: null pro_user: false blocked: false left_conversation_at: null discarded_at: null creator: id: 48102 first_name: Jordan last_name: Reyes avatar_background: '#4F46E5' image_url: null pro_user: true blocked: false blocker: false discarded_at: null '400': description: >- The conversation failed validation, for example a channel without a name or a channel created by a rep. The body maps each invalid field to its messages. content: application/json: schema: type: object additionalProperties: type: array items: type: string example: creator: - Channel can only be created by Admins '401': description: The bearer token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' example: message: Invalid credentials. '403': description: >- You are not a company admin or rep in this company, or your role lacks the messaging update permission. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: message: Not authorized. '422': description: >- The body has neither `conversation` nor `conversations` (empty body), or a parameter has the wrong type (an `error_message` and `errors` envelope). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: error_message: Invalid parameters errors: conversation: broadcasting: - must be boolean meta: request_id: 3f6c2a9e-8b1d-4f7a-9c35-2e8d41b07a6f timestamp: '2026-09-30T15:42:07Z' security: - bearer_auth: [] components: schemas: MessagingConversationCreateRequest: description: >- Send `conversation` (with `recipients`) to create one conversation, or `conversations` (with an optional `message`) to create several. type: object properties: conversation: $ref: '#/components/schemas/MessagingConversationAttributes' recipients: type: array description: >- The participants to add besides you. Required for every type except a channel, where it is ignored; send an empty array for a channel. items: $ref: '#/components/schemas/MessagingConversationRecipientReference' conversations: type: array description: Batch mode. Each entry creates one conversation. items: type: object properties: conversation: $ref: '#/components/schemas/MessagingConversationAttributes' recipients: type: array items: $ref: '#/components/schemas/MessagingConversationRecipientReference' additionalProperties: false message: $ref: '#/components/schemas/MessagingConversationFirstMessage' MessagingConversationSummary: description: >- A conversation as seen by the acting recipient. Per-recipient fields such as `unread`, `pinned`, and `muted` describe that recipient's view of the conversation. `recipients` lists at most six active participants; `total_recipients` is the full count. type: object properties: id: type: - integer - 'null' type: type: string description: The conversation type, for example `GroupConversation`. kind: type: - string - 'null' description: >- The short conversation kind (`direct`, `group`, `channel`, or `downline`), or null for SMS, email, and bot conversations. name: type: - string - 'null' description: type: - string - 'null' status: type: - string - 'null' description: >- One of `initiated`, `open`, `archived`, or `closed`. A new conversation stays `initiated` until its first message. conversation_type: type: - string - 'null' description: >- `internal` for conversations between company members, `external` for conversations with contacts. broadcasting: type: - boolean - 'null' auto_add_recipients: type: - boolean - 'null' announcing: type: - boolean - 'null' avatar_background_color: type: - string - 'null' avatar_emoji: type: - string - 'null' avatar_url: type: - string - 'null' image_url: type: - string - 'null' created_at: type: - string - 'null' format: date-time pinned_messages_count: type: - integer - 'null' total_recipients: type: - integer - 'null' unread: type: - boolean - 'null' pinned: type: - boolean - 'null' muted: type: - boolean - 'null' unread_messages_count: type: - integer - 'null' scheduled_messages_count: type: - integer - 'null' email_enabled?: type: - boolean - 'null' sms_enabled?: type: - boolean - 'null' messaging_enabled?: type: - boolean - 'null' description: Whether the acting recipient can post in the conversation. draft_message: description: The acting recipient's unsent draft in this conversation, or null. type: - object - 'null' recipients: type: array items: $ref: '#/components/schemas/MessagingConversationParticipant' creator: anyOf: - $ref: '#/components/schemas/MessagingConversationCreator' - type: 'null' required: - id - type - kind - name - description - status - conversation_type - broadcasting - auto_add_recipients - announcing - avatar_background_color - avatar_emoji - avatar_url - image_url - created_at - pinned_messages_count - total_recipients - unread - pinned - muted - unread_messages_count - scheduled_messages_count - email_enabled? - sms_enabled? - messaging_enabled? - draft_message - recipients - creator additionalProperties: false UnauthorizedResponse: type: object properties: message: type: string required: - message StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' MessagingConversationAttributes: description: The conversation to create. type: object properties: type: type: string description: The conversation type. Required unless `kind` is set. enum: - ChannelConversation - DirectConversation - GroupConversation - SmsConversation - EmailConversation - BotConversation kind: type: string description: >- Alternative to `type` using the short name. Ignored when `type` is set. enum: - channel - direct - group name: type: string description: >- The conversation name. Required for a channel. A group name must be unique among your open groups, and a channel name among your open channels. description: type: string broadcasting: type: boolean description: >- For a channel, when true only admins can post; other members can only read. filter: type: object description: >- For a channel, the audience to add as members, as member attributes (such as `member_type_id` or `rank_id`) mapped to the values to match. Omit it to add only you. additionalProperties: $ref: '#/components/schemas/JsonValue' auto_add_recipients: type: boolean description: >- For a channel, keep adding members who match `filter` as they join the company. Ignored unless you are a company admin. additionalProperties: false MessagingConversationRecipientReference: description: >- A participant to add. Identify an existing recipient by `uid`; otherwise the recipient is found or created from `email` or `phone`. type: object properties: uid: type: - integer - string description: The recipient ID of an existing company member or contact. email: type: string format: email phone: type: string first_name: type: string description: Used when a new contact is created from `email` or `phone`. last_name: type: string description: Used when a new contact is created from `email` or `phone`. id: type: - integer - string description: Accepted for compatibility and ignored. Use `uid`. image_url: type: - string - 'null' description: Accepted for compatibility and ignored. additionalProperties: false MessagingConversationFirstMessage: description: >- Batch mode only. A message sent from you to each conversation created from `conversations`. Ignored with `conversation`. type: object properties: body: type: string theme: type: string type: type: string description: >- The message type. Ignored for conversations between company members, which always get a direct message. attachments_attributes: type: array items: type: object properties: url: type: string format: uri filename: type: string kind: type: string content_size: type: - integer - string description: The file size in bytes. content_type: type: string additionalProperties: false additionalProperties: false MessagingConversationParticipant: description: >- A participant in a conversation, as listed in the conversation's `recipients`. Company members carry `status` and `last_online`; contacts carry `email` and `phone` instead. type: object properties: id: type: integer description: >- The recipient ID. Pass it as `uid` to add this recipient to another conversation. receivable_id: type: - integer - 'null' receivable_type: type: - string - 'null' description: What the participant is, such as a company member or a contact. first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' phone: type: - string - 'null' status: type: - string - 'null' last_online: type: - string - 'null' avatar_background: type: - string - 'null' avatar_url: type: - string - 'null' image_url: type: - string - 'null' country_name: type: - string - 'null' pro_user: type: - boolean - 'null' blocked: type: - boolean - 'null' description: Whether the acting recipient has blocked this participant. left_conversation_at: type: - string - 'null' conversation_messaging_enabled?: type: - boolean - 'null' discarded_at: type: - string - 'null' required: - id additionalProperties: false MessagingConversationCreator: description: The recipient who created a conversation. type: object properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' phone: type: - string - 'null' avatar_background: type: - string - 'null' image_url: type: - string - 'null' pro_user: type: - boolean - 'null' blocked: type: - boolean - 'null' blocker: type: - boolean - 'null' discarded_at: type: - string - 'null' required: - id additionalProperties: false ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time 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' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````