> ## 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 <token>; 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.

# Build and Share a Standalone Form with the API

> Create a standalone form, make it public, embed or share it, and read its responses — all through the Forms API.

A **standalone form** is a form you share by link or embed, rather than one checkout shows during enrollment. Use it for a reseller application, an event RSVP, a product-interest survey — anything you want people to fill in outside of a purchase. This guide builds one end to end with the Forms API: write its fields, publish it, hand out its link, and read what comes back.

If you instead want a form that appears at **enrollment checkout** after payment, read [Checkout Forms](https://docs.fluid.app/guides/checkout-forms.md). The field model is the same; the way the form reaches people is different.

## The model

A standalone form is a `general` form. Unlike a checkout form, it has no country targeting and no cart — it is reached through a **public token**. Once the form is active and has a token, Fluid gives you a share link and an embed snippet, and anyone with the link can respond. You read the responses back through the same API.

The lifecycle is: **create a draft → activate it (which mints the share token) → share or embed it → read responses → revoke access when you're done.**

## Build a form through the API

Every request takes a company Bearer token. Reading needs the forms view permission, and writing needs the forms update permission. The steps below build Dunder Mifflin's reseller application. Each operation's reference page holds its full parameters and responses.

### Write the fields

Each field is a component: an object with an `element_type` and its settings. [List form elements](https://docs.fluid.app/api-reference/form-elements/list-form-elements.md) describes every element type. Dunder Mifflin saves the fields in `reseller-application.json`:

```json reseller-application.json theme={null}
[
  {
    "element_type": "input",
    "puck_type": "legal_name",
    "label": "Business legal name",
    "required": true,
    "is_form_field": true
  },
  {
    "element_type": "input",
    "puck_type": "email",
    "label": "Contact email",
    "required": true,
    "is_form_field": true
  },
  {
    "element_type": "multiple_choice_entry",
    "label": "Business type",
    "multiple_choice_options": [
      { "label": "Independent retailer" },
      { "label": "Wholesaler" },
      { "label": "Online only" },
      { "label": "Other" }
    ],
    "required": true,
    "is_form_field": true
  },
  {
    "element_type": "short_text_entry",
    "label": "Employer Identification Number (EIN)",
    "placeholder": "12-3456789",
    "required": true,
    "sensitive_info": true,
    "is_form_field": true
  },
  {
    "element_type": "short_text_entry",
    "label": "Referral code",
    "placeholder": "SPRING-Reseller",
    "required": false,
    "case_sensitive": true,
    "is_form_field": true
  },
  {
    "element_type": "long_text_entry",
    "label": "Tell us about your business",
    "required": false,
    "is_form_field": true
  }
]
```

* Set `is_form_field` to `true` on every component that collects an answer. Structural blocks such as headers and section labels leave it off.
* An identity field is an `input` whose `puck_type` names it, such as `legal_name`, `email`, or `phone_number`.
* Mark a field `sensitive_info` to have Fluid treat its answers as sensitive: they are masked on read and export unless the caller holds the forms view-sensitive permission. The EIN above is one such field.
* Mark a text field `case_sensitive` when capital letters are meaningful, like the referral code above. Fluid stores the flag on the field and returns it in the field's metadata so exports and integrations can honor it; the API itself does not change or validate the answer.
* Fields appear in the order you list them.

### Create the form as a draft

`form_components` is a JSON-encoded string, not an array. Let `jq` encode the file into the request body, and set `form_type` to `general`:

```bash theme={null}
jq -n --arg components "$(jq -c . reseller-application.json)" '{
  form: {
    title: "Reseller application",
    form_type: "general",
    status: "draft",
    form_components: $components
  }
}' > create-form.json

curl -X POST "https://api.fluid.app/api/forms" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: reseller-application-2026-11" \
  --data @create-form.json
```

* Send the fields inside the `form` object. The API reads nothing outside it.
* Set `form_type` to `general` for a standalone form. `post_purchase` makes a checkout form instead, and `pre_purchase` is retired and returns `422`.
* A new form is a `draft` unless you set `status`, so no one sees it while you check it.
* Marking a field `sensitive_info` needs the forms manage-sensitive permission. Without it, the request returns `422` and creates nothing.
* The `Idempotency-Key` header makes a retry safe: the same request with the same key returns the form the first request created.

See [Create a form](https://docs.fluid.app/api-reference/forms/create-a-form.md) for the full request and response. The response returns the form with its `id`, here `5821`, and its `form_components` carry each element's `id`. Save the response; you need those IDs to change the fields later.

### Activate it, which mints the share token

A standalone form is reachable only when it is **active and holds a public token**. Activating the form mints that token for you, so send the status change as an update:

```bash theme={null}
curl -X PUT "https://api.fluid.app/api/forms/5821" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"form": {"status": "active"}}'
```

> [!WARNING]
>
> Activate the form by **changing** its status to `active`; don't create it `active` in one step. The token is minted on the transition to active, so a form created directly as `active` is live but has no share link until you call [Generate a public token](https://docs.fluid.app/api-reference/forms/generate-a-public-token.md).

To rotate the token later — for example if a link leaks — call [Generate a public token](https://docs.fluid.app/api-reference/forms/generate-a-public-token.md) (`POST /api/forms/{id}/generate_token`). It replaces the current token with a new one, so the old link stops working.

### Set who can reach it

A standalone form is public by default once it has a token. Tighten access with [Update embed settings](https://docs.fluid.app/api-reference/forms/update-embed-settings.md) (`PATCH /api/forms/{id}/embed_settings`). Send only the controls you want; each is optional:

```bash theme={null}
curl -X PATCH "https://api.fluid.app/api/forms/5821/embed_settings" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "embed_settings": {
      "allowed_domains": ["partners.dundermifflin.com"],
      "expires_at": "2026-12-31T23:59:59Z",
      "max_submissions": 500,
      "require_contact": true
    }
  }'
```

* `allowed_domains` limits which sites may embed the form.
* `expires_at` closes the form at a datetime; `max_submissions` closes it after a number of responses.
* `require_contact` makes every public submission include a contact email.
* To password-protect the form, send a `password`; send `remove_password` to clear it.

### Share it or embed it

Once the form is active and has a token, [Get embed code](https://docs.fluid.app/api-reference/forms/get-embed-code.md) (`GET /api/forms/{id}/embed_code`) returns everything you need to publish it:

```bash theme={null}
curl "https://api.fluid.app/api/forms/5821/embed_code" \
  -H "Authorization: Bearer <token>"
```

The response carries:

* `share_url` — the hosted link to send people or post anywhere.
* `embed_url` — the same form for embedding in an `iframe`.
* `iframe_snippet` and `script_snippet` — ready-to-paste HTML for your own site.

> [!NOTE]
>
> This endpoint needs a public token. If the form has none yet, it fails — activate the form or generate a token first, then call it again.

### Read the responses

Each submission is a respondent with their answers. List them with [List form respondents](https://docs.fluid.app/api-reference/forms/list-form-respondents.md) (`GET /api/forms/{id}/respondents`), or pull everything at once with [Export form responses as CSV](https://docs.fluid.app/api-reference/forms/export-form-responses-as-csv.md) (`POST /api/forms/{id}/export_csv`):

```bash theme={null}
curl "https://api.fluid.app/api/forms/5821/respondents" \
  -H "Authorization: Bearer <token>"
```

A sensitive field's answer comes back masked as `********` unless the caller holds the forms view-sensitive permission, is a root admin, or uses a droplet token. A CSV export additionally needs `include_sensitive=true` to return those answers unmasked; without it, even a permitted caller gets masked values.

### Turn access back off

When the form has run its course, revoke its public token with [Revoke the public token](https://docs.fluid.app/api-reference/forms/revoke-the-public-token.md) (`DELETE /api/forms/{id}/revoke_token`). The share link and embed stop working, and the form's existing responses are kept. Revoking doesn't change the form's status, so to share it again you call [Generate a public token](https://docs.fluid.app/api-reference/forms/generate-a-public-token.md) to mint a fresh token.

### Change fields without dropping answers

To edit a live form, send its components back to [Update a form](https://docs.fluid.app/api-reference/forms/update-a-form.md) with their IDs. A component that carries the `id` of one of this form's elements updates that element in place; a component without an `id` adds a new element; an element you leave out is deactivated, and its stored answers are kept. Take the IDs from the create or update response's `form_components`, not from [List form elements](https://docs.fluid.app/api-reference/form-elements/list-form-elements.md), which also lists deactivated elements.

## Gotchas

* **A form created `active` has no share link.** The token is minted when status changes to active, so create a draft and then activate it, or call [Generate a public token](https://docs.fluid.app/api-reference/forms/generate-a-public-token.md).
* **`form_components` is a JSON-encoded string**, not a JSON array. Encode the array into a string before you send it.
* **`sensitive_info` is permission-gated.** Changing which fields are sensitive needs the forms manage-sensitive permission, or the request returns `422`.
* **`case_sensitive` is a stored hint**, not a validation. Fluid keeps it on the field and returns it in metadata for exports and integrations; it does not alter the stored answer.

## Related pages

* [Checkout Forms](https://docs.fluid.app/guides/checkout-forms.md) — forms shown at enrollment checkout after payment.
* [Forms API reference](https://docs.fluid.app/api-reference/forms/list-forms.md) — every form operation in full.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.