> ## 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. > 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. > 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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/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. # Update company media > Update an existing media item. The attached_shareables_attributes field creates or modifies video-shopping overlays and returns 422 for substantive entries on non-video media. Destroy-only entries can remove legacy overlays from non-video media. ## OpenAPI ````yaml /api-reference/company-v0.yaml put /api/company/media/{id} openapi: 3.1.0 info: title: Fluid Company API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/company/media/{id}: put: tags: - media summary: Update company media description: >- Update an existing media item. The attached_shareables_attributes field creates or modifies video-shopping overlays and returns 422 for substantive entries on non-video media. Destroy-only entries can remove legacy overlays from non-video media. operationId: company_v0_update_company_media parameters: - name: id in: path required: true schema: type: integer example: 1 description: Media ID - name: language_iso in: query schema: type: string required: false description: Language code for translations (e.g., 'en', 'es', 'de') requestBody: description: >- Media attributes. Video-shopping overlay writes use attached_shareables_attributes and require video media. Null, empty, and destroy-only values are accepted for non-video media. content: application/json: schema: $ref: '#/components/schemas/MediaUpdate' responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/CompanyClientUpdateCompanyMediaResponse200ApplicationJsonSchema '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Unsupported non-video overlay or invalid media parameters content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: MediaUpdate: type: - object - 'null' properties: id: type: - integer - string - number - 'null' medium: type: - object - 'null' properties: user_id: type: - integer - string - number - 'null' media_type: type: - string - number - integer - 'null' minLength: 1 image_url: type: - string - 'null' - number - integer video_url: type: - string - 'null' - number - integer pdf_url: type: - string - 'null' - number - integer powerpoint_url: type: - string - number - integer - 'null' minLength: 1 title: type: - string - number - integer - 'null' minLength: 1 description: type: - string - 'null' - number - integer active: type: - boolean - 'null' not: type: - string - 'null' compressed_image_url: type: - string - number - integer - 'null' minLength: 1 prompts_enabled: type: - boolean - 'null' not: type: - string - 'null' kind: type: - string - number - integer - 'null' minLength: 1 visibility: type: - string - number - integer - 'null' minLength: 1 cta_enabled: type: - boolean - 'null' not: type: - string - 'null' cta_action_type: type: - string - number - integer - 'null' minLength: 1 cta_url: type: - string - 'null' - number - integer cta_button_text: type: - string - number - integer - 'null' minLength: 1 slug: type: - string - 'null' - number - integer custom_slug: type: - boolean - 'null' not: type: - string - 'null' no_index: type: - boolean - 'null' not: type: - string - 'null' display_comments: type: - boolean - 'null' not: type: - string - 'null' category: type: - string - number - integer - 'null' minLength: 1 display_shop: type: - boolean - 'null' not: type: - string - 'null' dam_asset_id: type: - integer - string - number - 'null' dam_asset_code: type: - string - number - integer - 'null' minLength: 1 lead_capture: type: - boolean - 'null' not: type: - string - 'null' video_shopping_enabled: type: - boolean - 'null' not: type: - string - 'null' application_theme_template_id: type: - integer - string - number - 'null' publish_at: type: - string - 'null' - number - integer format: time settings: type: - object - 'null' properties: player: type: - object - 'null' properties: primary_color: type: - string - number - integer - 'null' minLength: 1 button_border_radius: type: - string - number - integer - 'null' minLength: 1 control_bar_height: type: - string - number - integer - 'null' minLength: 1 progress_color: type: - string - number - integer - 'null' minLength: 1 volume_color: type: - string - number - integer - 'null' minLength: 1 show_controls: type: - boolean - 'null' not: type: - string - 'null' autoplay: type: - boolean - 'null' not: type: - string - 'null' loop: type: - boolean - 'null' not: type: - string - 'null' muted: type: - boolean - 'null' not: type: - string - 'null' preload: type: - string - number - integer - 'null' minLength: 1 playback_rates: type: - string - number - integer - 'null' minLength: 1 show_remaining_time: type: - boolean - 'null' not: type: - string - 'null' responsive: type: - boolean - 'null' not: type: - string - 'null' fluid: type: - boolean - 'null' not: type: - string - 'null' embed: type: - object - 'null' properties: behavior: type: - string - number - integer - 'null' minLength: 1 responsive: type: - boolean - 'null' not: type: - string - 'null' width: type: - string - number - integer - 'null' minLength: 1 height: type: - string - number - integer - 'null' minLength: 1 show_controls: type: - boolean - 'null' not: type: - string - 'null' autoplay: type: - boolean - 'null' not: type: - string - 'null' loop: type: - boolean - 'null' not: type: - string - 'null' cta: type: - object - 'null' properties: enabled: type: - boolean - 'null' not: type: - string - 'null' type: type: - string - number - integer - 'null' minLength: 1 url: type: - string - 'null' - number - integer button_description: type: - string - 'null' - number - integer button_text: type: - string - number - integer - 'null' minLength: 1 button_color: type: - string - number - integer - 'null' minLength: 1 fair_share: type: - object - 'null' properties: bg_color: type: - string - number - integer - 'null' minLength: 1 rep_name: type: - string - number - integer - 'null' minLength: 1 rep_avatar: type: - string - number - integer - 'null' minLength: 1 message: type: - string - number - integer - 'null' minLength: 1 live_chat: type: - object - 'null' properties: enabled: type: - boolean - 'null' not: type: - string - 'null' color: type: - string - number - integer - 'null' minLength: 1 welcome_message: type: - string - number - integer - 'null' minLength: 1 thumbnail: type: - object - 'null' properties: show_title: type: - boolean - 'null' not: type: - string - 'null' show_description: type: - boolean - 'null' not: type: - string - 'null' seo: type: - object - 'null' properties: title: type: - string - number - integer - 'null' minLength: 1 description: type: - string - number - integer - 'null' minLength: 1 image_url: type: - string - number - integer - 'null' minLength: 1 image_path: type: - string - number - integer - 'null' minLength: 1 block_crawler: type: - boolean - 'null' not: type: - string - 'null' label: type: - object - 'null' properties: id: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' minLength: 1 subtitles: type: - array - 'null' items: type: - object - 'null' properties: lang: type: - string - number - integer - 'null' minLength: 1 src: type: - string - number - integer - 'null' minLength: 1 available_countries: type: - array - 'null' items: type: - string - number - integer - 'null' tags_attributes: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' _destroy: type: - boolean - 'null' not: type: - string - 'null' name: type: - string - number - integer - 'null' minLength: 1 prompts_attributes: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' minLength: 1 content: type: - string - number - integer - 'null' minLength: 1 _destroy: type: - boolean - 'null' not: type: - string - 'null' attached_shareables_attributes: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' attachment_type: type: - string - number - integer - 'null' minLength: 1 attachment_id: type: - integer - string - number - 'null' timestamp: type: - string - number - integer - 'null' minLength: 1 _destroy: type: - boolean - 'null' not: type: - string - 'null' description: >- Video-shopping overlay attributes. Substantive create or modify entries are supported only for video media. Omitted, null, empty, and destroy-only values remain valid for non-video media so legacy overlays can be removed. CompanyClientUpdateCompanyMediaResponse200ApplicationJsonSchema: type: - object - 'null' properties: medium: anyOf: - $ref: '#/components/schemas/MediumSerializer' - type: 'null' meta: anyOf: - $ref: '#/components/schemas/Meta' - type: 'null' 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' MediumSerializer: title: MediumSerializer type: - object - 'null' description: Media resource with user-specific data and associations properties: id: type: - integer - string - number - 'null' user_id: type: - integer - 'null' - string - number title: type: - string - number - integer - 'null' description: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' stripped: type: - string - 'null' - number - integer media_type: type: - string - number - integer - 'null' media_format: type: - string - 'null' - number - integer image_url: type: - string - 'null' - number - integer video_url: type: - string - 'null' - number - integer pdf_url: type: - string - 'null' - number - integer kind: type: - string - 'null' - number - integer active: type: - boolean - 'null' visibility: type: - integer - 'null' - string - number share_link: type: - string - 'null' - number - integer preview_link: type: - string - 'null' - number - integer views: type: - integer - string - number - 'null' leads: type: - integer - string - number - 'null' watch: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' video_status: type: - string - 'null' - number - integer duration: type: - integer - 'null' - string - number cta_url: type: - string - 'null' - number - integer cta_button_text: type: - string - 'null' - number - integer cta_enabled: type: - boolean - 'null' cta_action_type: type: - string - 'null' - number - integer video_shopping_enabled: type: - boolean - 'null' prompts_enabled: type: - boolean - 'null' ranks: type: - array - 'null' items: type: - string - number - integer - 'null' settings: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' application_theme_template_id: type: - integer - 'null' - string - number created_at: type: - string - number - integer - 'null' format: date-time subtitles: type: - object - 'null' description: Hash of language ISO codes to subtitle text additionalProperties: type: - string - number - integer - 'null' countries: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' iso: type: - string - number - integer - 'null' name: type: - string - number - integer - 'null' tags: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' slug: type: - string - 'null' - number - integer description: URL-friendly slug for the media item canonical_url: type: - string - 'null' - number - integer description: >- The primary URL for accessing this media item on the company's website custom_slug: type: - boolean - 'null' description: Whether the slug was customized by the user prompts: type: - array - 'null' description: Only included if media_type is 'share' or 'upload' items: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' attached_shareables: type: - array - 'null' items: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' comments: type: - array - 'null' description: >- Only included if video_shopping_enabled is true and display_comments is true items: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' label: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' description: Label object from LabelConcern - type: 'null' display_tag: type: - string - 'null' - number - integer description: Display tag from LabelConcern publish_at: type: - string - 'null' - number - integer format: date-time description: >- Scheduled publish date/time. If set to a future date, the media will not be publicly accessible until that time. Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' 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 ````