> ## 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. # Turn on SMS reminders > Records that the merchant wants SMS reminders and queues the work: register the merchant's own toll-free number, file Twilio's verification with the merchant's own details and opt-in images, and turn the sms_reminders setting on when Twilio approves (about 3 business days). Nothing is bought or filed while details are missing; the answer lists them. Safe to repeat: it keeps the first request, adopts an existing sender, and never files a verification twice. Repeat it after fixing missing fields. Answers 409 sms_not_allowed where live SMS is switched off. ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/subscription_pro/sms_onboarding openapi: 3.1.0 info: title: Fluid Settings 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: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/subscription_pro/sms_onboarding: post: tags: - subscription-pro summary: Turn on SMS reminders description: >- Records that the merchant wants SMS reminders and queues the work: register the merchant's own toll-free number, file Twilio's verification with the merchant's own details and opt-in images, and turn the sms_reminders setting on when Twilio approves (about 3 business days). Nothing is bought or filed while details are missing; the answer lists them. Safe to repeat: it keeps the first request, adopts an existing sender, and never files a verification twice. Repeat it after fixing missing fields. Answers 409 sms_not_allowed where live SMS is switched off. operationId: settings_v0_create_subscription_pro_sms_onboarding responses: '200': description: The request is recorded; the status says what happens next content: application/json: schema: $ref: '#/components/schemas/SubscriptionProSmsOnboardingResponse' example: subscription_pro_sms_onboarding: state: needs_details requested: true publicly_traded: null needs_public_answer: true sms_reminders_enabled: false sms_available: true disclosure_published: true can_resubmit: false phone_number: null submitted_at: null verified_at: null missing: - field: business_registration_number type: missing_ein reason: Add the business's EIN to its legal entity. - field: business_type type: business_type_needs_public_answer reason: Tell us whether your company is publicly traded. rejection: null status: 200 meta: request_id: 7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42 timestamp: '2026-11-10T14:05:31Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: Not an admin, missing the orders.settings permission, or a droplet content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: >- Subscription Pro is not active for the company (details.error is subscription_pro_inactive). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '409': description: >- SMS is switched off for this company or environment (sms_not_allowed). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: SubscriptionProSmsOnboardingResponse: type: object additionalProperties: false required: - subscription_pro_sms_onboarding - status - meta properties: subscription_pro_sms_onboarding: $ref: '#/components/schemas/SubscriptionProSmsOnboarding' status: type: integer enum: - 200 meta: $ref: '#/components/schemas/Meta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' SubscriptionProSmsOnboarding: type: object additionalProperties: false required: - state - requested - publicly_traded - needs_public_answer - sms_reminders_enabled - sms_available - disclosure_published - can_resubmit - phone_number - submitted_at - verified_at - missing - rejection properties: state: type: string enum: - not_started - needs_details - provisioning - in_review - approved - rejected description: >- not_started: the merchant has not asked yet. needs_details: the merchant asked, and Fluid cannot file the verification until the fields in missing are fixed. provisioning: the merchant asked and nothing is missing; Fluid is registering the toll-free number and filing the verification. in_review: Twilio is reviewing (about 3 business days). approved: Twilio approved; sms_reminders turns on by itself when the merchant asked, else the merchant turns it on. rejected: Twilio rejected the verification (see rejection). requested: type: boolean description: >- Whether the merchant asked for SMS reminders. Approval turns the sms_reminders setting on by itself while this is true. publicly_traded: type: - boolean - 'null' description: >- The merchant's answer to "is the business publicly traded?", or null before it answered. needs_public_answer: type: boolean description: >- Whether the merchant still has to answer publicly_traded. True when the legal entity is a plain corporation or C-corp and no answer is stored. sms_reminders_enabled: type: boolean description: Whether the sms_reminders setting is on. sms_available: type: boolean description: >- Whether Fluid can set up SMS in this environment. False where live SMS is switched off. disclosure_published: type: boolean description: >- Whether the SMS consent disclosure is published. Filing waits for it, and so does the sms_reminders setting. can_resubmit: type: boolean description: >- Whether a rejected verification can be sent again now (rejected, with nothing missing). phone_number: type: - string - 'null' description: >- The merchant's own toll-free number, in E.164, once it is registered. submitted_at: type: - string - 'null' format: date-time verified_at: type: - string - 'null' format: date-time missing: type: array description: >- What Fluid still needs from the merchant, with a reason a merchant can act on. Names only; the values never leave the server. Empty while the verification is in review or approved. items: type: object additionalProperties: false required: - field - type - reason properties: field: type: string description: The Twilio verification field for example business_registration_number or privacy_policy_url.: null type: type: string description: >- missing_entity, missing_authorized_signatory, missing_field, invalid_field, missing_ein, unsupported_business_type, business_type_needs_public_answer or unsupported_country. reason: type: string rejection: description: Twilio's rejection, or null unless the state is rejected. oneOf: - type: 'null' - type: object additionalProperties: false required: - reason - reasons - edit_allowed - edit_deadline properties: reason: type: - string - 'null' reasons: type: array items: type: object edit_allowed: type: boolean description: >- Whether Twilio still allows an edit of this verification (resubmit then edits it; otherwise it files a new one). edit_deadline: type: - string - 'null' format: date-time Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time 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' 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.