Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card’s new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment’s: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work’s linked discussions sit on.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Fluid","colors":{"primary":"#2464ec","light":"#0C0C3D"},"logo":{"light":"https://mintcdn.com/fluid-090e382c/AJPEXVHos0QzPSg_/logo.svg?fit=max\u0026auto=format\u0026n=AJPEXVHos0QzPSg_\u0026q=85\u0026s=1c26f326aef44f8645210ea4e7bfdf8b","dark":"https://mintcdn.com/fluid-090e382c/o1_Z9qgDewnZ_Q2C/logo-dark.svg?fit=max\u0026auto=format\u0026n=o1_Z9qgDewnZ_Q2C\u0026q=85\u0026s=c9f4276b6f0924afdc876dedfbfef7fb"},"favicon":"https://mintcdn.com/fluid-090e382c/rpDwZDP_B50P5eoU/favicon.svg?fit=max\u0026auto=format\u0026n=rpDwZDP_B50P5eoU\u0026q=85\u0026s=a852a8458b6eba05cb8be789f1e4bc72","navbar":{"links":[{"href":"/help/getting-help","label":"Support"},{"href":"https://admin.fluid.app/sign-up","label":"Sign up"}],"primary":{"type":"button","label":"Admin Portal","href":"https://admin.fluid.app"}},"footer":{"socials":{"x":"https://x.com/fluidwecommerce"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"markdown":{"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 \u003ctoken>; 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.","To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/\u003cname>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/\u003cname> on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). See /sites/functions and /sites/rest-api.","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."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fluid-090e382c","hasAudioNarration":false,"actualSubdomain":"fluid-090e382c","customDomains":["docs.fluid.app"],"gitSource":{"type":"github","owner":"fluid-commerce","repo":"mintlify-starter","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af6464cb80fe866f86b02f1","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API Reference","count":2469},{"language":"default","tag":"Portal \u0026 Widgets","count":431},{"language":"default","tag":"Settings","count":380},{"language":"default","tag":"Widget Worker SDK Reference","count":357},{"language":"default","tag":"Member API","count":217},{"language":"default","tag":"Legacy (v0)","count":217},{"language":"default","tag":"Variables","count":216},{"language":"default","tag":"Website","count":190},{"language":"default","tag":"Messaging","count":184},{"language":"default","tag":"People","count":179}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html.dark #sidebar-content li>a,html.dark #sidebar-content li>button,html.dark #table-of-contents li>a,html.dark #navbar a.link,html.dark #navbar a[href^=\"mailto:\"]{color:#a0a1a5}html.dark #sidebar-content li>a:hover,html.dark #sidebar-content li>button:hover,html.dark #sidebar-content li[data-active]>a,html.dark #table-of-contents li>a:hover,html.dark #table-of-contents li[data-active]>a,html.dark #navbar a.link:hover,html.dark #navbar a.link[aria-current],html.dark #navbar a[href^=\"mailto:\"]:hover{color:#ffffff}html.dark{--primary-light: 255 255 255}html.dark :is(a,button)[class~=\"dark:bg-primary-light\"],html.dark :is(a,button)[class~=\"dark:bg-primary-light!\"],html.dark :is(a,button)[class~=\"dark:hover:bg-primary-light\"]:hover,html.dark :is(a,button)[class~=\"dark:hover:bg-primary-light!\"]:hover{background-color:#0c0c3d!important}html.dark :is(a,button)[class~=\"dark:bg-primary-light\"],html.dark :is(a,button)[class~=\"dark:bg-primary-light\"] *,html.dark :is(a,button)[class~=\"dark:bg-primary-light!\"],html.dark :is(a,button)[class~=\"dark:bg-primary-light!\"] *{color:#ffffff}"}],"page":{"pagePath":"api-reference/cowork-tasks/place-the-companys-work-on-the-board","slug":"/api-reference/cowork-tasks/place-the-companys-work-on-the-board","pageMetadata":{"title":"Place the company's work on the board","description":"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card's new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment's: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/position","href":"/api-reference/cowork-tasks/place-the-companys-work-on-the-board","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card’s new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment’s: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work’s linked discussions sit on.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Place the company's work on the board","description":"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card's new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment's: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/position","href":"/api-reference/cowork-tasks/place-the-companys-work-on-the-board","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"modifyMultiplayerTaskBoardPosition","tags":["Cowork tasks"],"x-fluid-audience":"company","summary":"Place the company's work on the board","description":"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card's new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment's: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.","security":["28ddf9a5-3bae-48be-ba8b-24f4a142065e"],"parameters":["ea8d0293-8816-44f7-a458-85172973ad5a"],"requestBody":"3352cad9-8acb-4881-81ec-a14a5a2889bf","responses":{"200":"fe6072a7-64ac-43b1-9d4d-8f0acd51c4de","401":"fa0d62e7-9942-4ac6-a1a0-b11bdf53b2d3","403":"1e5a6f92-daaa-4e61-a0de-11b8a7314ae9","404":"225bf07a-6bc6-4db2-9887-f12cb9204911","410":"ba811672-b025-4b3b-b8b2-a8e57efd7eb6","422":"7ad5780b-6eba-4f28-a044-e3171e7efbe7"},"method":"put","type":"path","servers":["8f48aa1c-b7f3-40fa-b28f-3a6b740a0316"],"path":"/api/v202604/multiplayer/tasks/{id}/position","baseUrlOptions":["https://api.fluid.app"],"title":"Place the company's work on the board","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ea8d0293-8816-44f7-a458-85172973ad5a":{"name":"id","in":"path","required":true,"description":"The task UUID returned at creation or in a task page.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The task UUID returned at creation or in a task page.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"example":{"position_change":{"board_position":"a0V","board_position_at_ms":1789000000000}},"schema":{"type":"object","required":["position_change"],"properties":{"position_change":{"type":"object","required":["board_position","board_position_at_ms"],"properties":{"board_position":{"oneOf":[{"type":"string","pattern":"^[0-9A-Za-z]+$","maxLength":255,"description":"The fractional index to store, or null to take the work out of the order.","isRequired":true,"uniqueKey":"position_change.board_position.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9A-Za-z]+$","maxLength":255,"description":"The fractional index to store, or null to take the work out of the order.","isRequired":true,"uniqueKey":"position_change.board_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"position_change.board_position","typeLabel":"string | null"},"board_position_at_ms":{"type":"integer","minimum":1,"maximum":253402300799999,"description":"When the card was placed, in Unix milliseconds. The newer placement wins. A stamp ahead of the server's clock is stored as the server's time, so a client clock running fast cannot hold the card still.","isRequired":true,"uniqueKey":"position_change.board_position_at_ms","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"position_change","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"position_change":{"board_position":"a0V","board_position_at_ms":1789000000000}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"fe6072a7-64ac-43b1-9d4d-8f0acd51c4de":{"description":"The task at its new position, or as it is when a newer placement is already stored.","content":{"application/json":{"example":{"task":{"id":"01a1d0e3-e17a-7dcb-aaf7-471e531566c2","agency":null,"agency_join_request":null,"agency_request":null,"assignee":null,"assigner":null,"board_position":"a0V","board_position_at_ms":1789000000000,"category":null,"client_id":"dup-03fb70b130ea","company_id":96778814,"conversation_id":null,"created_at":"2026-11-12T16:52:37Z","creator_id":433400890,"description":"Pay button dead on my phone","due_on":null,"kind":null,"lock_version":1,"merged_from":[],"merged_into":{"id":"01a1d0e3-e177-7a20-bb9d-f43b802d7615","title":"Place order button does nothing on iPhone","deleted":false},"mist_confidence":{"state":"current","assessment_id":"01a1d0e3-e17c-72cc-b14f-5066a1b1fa37","score":4,"band":"green","summary":"A clear change.","concerns":["Detail"],"raise_by":[],"assessed_at":"2026-11-12T17:52:37.755Z","suggested_kind":"change","category":"eng","difficulty":"easy","hours_low":1,"hours_high":2,"questions":[]},"plan":null,"priority":null,"run_id":null,"run_thread_id":null,"source_threads":[],"status":"skipped","status_editable":true,"tags":[],"title":"Cannot tap pay on my phone","updated_at":"2026-11-12T17:52:37Z"},"status":200,"meta":{"request_uuid":null,"timestamp":"2026-11-12T17:52:37Z"}},"schema":{"type":"object","required":["task","status","meta"],"properties":{"task":{"type":"object","required":["id","client_id","company_id","creator_id","title","description","status","priority","board_position","due_on","kind","category","plan","board_position_at_ms","lock_version","run_id","run_thread_id","tags","agency","assignee","assigner","source_threads","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"client_id":{"type":"string","isRequired":true,"uniqueKey":"task.client_id","typeLabel":"string"},"company_id":{"type":"integer","isRequired":true,"uniqueKey":"task.company_id","typeLabel":"integer"},"creator_id":{"type":"integer","isRequired":true,"uniqueKey":"task.creator_id","typeLabel":"integer"},"title":{"type":"string","isRequired":true,"uniqueKey":"task.title","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"task.description","typeLabel":"string"},"status":{"type":"string","enum":["open","kept","needs_info","in_progress","handed","review","skipped"],"isRequired":true,"uniqueKey":"task.status","typeLabel":"enum\u003cstring>"},"priority":{"oneOf":[{"type":"string","enum":["urgent","high","medium","low",null],"description":"How urgent the work is, or null when nobody has judged it.","isRequired":true,"uniqueKey":"task.priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["urgent","high","medium","low",null],"description":"How urgent the work is, or null when nobody has judged it.","isRequired":true,"uniqueKey":"task.priority.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.priority","typeLabel":"enum\u003cstring> | null"},"due_on":{"oneOf":[{"type":"string","format":"date","description":"The calendar day the work is due, as YYYY-MM-DD, or null when no date has been set. A day and not an instant: it carries no time zone and reads as the same day for everyone.","isRequired":true,"uniqueKey":"task.due_on.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The calendar day the work is due, as YYYY-MM-DD, or null when no date has been set. A day and not an instant: it carries no time zone and reads as the same day for everyone.","isRequired":true,"uniqueKey":"task.due_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.due_on","typeLabel":"string\u003cdate> | null"},"kind":{"oneOf":[{"type":"string","enum":["bug","change","feature","design","support",null],"description":"What kind of work this is, as Mist classified the request Cowork made it from, or null when nobody has. change is an edit to content, data or settings that is neither a fault nor something new.","isRequired":true,"uniqueKey":"task.kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["bug","change","feature","design","support",null],"description":"What kind of work this is, as Mist classified the request Cowork made it from, or null when nobody has. change is an edit to content, data or settings that is neither a fault nor something new.","isRequired":true,"uniqueKey":"task.kind.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.kind","typeLabel":"enum\u003cstring> | null"},"category":{"oneOf":[{"type":"string","enum":["design","support","eng",null],"description":"The department the work's kind belongs to: design, support, or eng for bugs, changes and features. Derived from kind and never written, so it is null exactly when kind is.","isRequired":true,"uniqueKey":"task.category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["design","support","eng",null],"description":"The department the work's kind belongs to: design, support, or eng for bugs, changes and features. Derived from kind and never written, so it is null exactly when kind is.","isRequired":true,"uniqueKey":"task.category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.category","typeLabel":"enum\u003cstring> | null"},"plan":{"oneOf":[{"type":"array","minItems":2,"maxItems":8,"description":"The steps Mist planned for the work when Cowork made it from a chat, in order, or null when there is no plan: work with a single step has none. A proposal of how the work goes; nothing in it has been approved or done.","items":{"type":"object","additionalProperties":false,"required":["title","outcome"],"properties":{"title":{"type":"string","maxLength":120,"isRequired":true,"uniqueKey":"task.plan.oneOf.0.items.[INDEX].title","typeLabel":"string"},"outcome":{"type":"string","maxLength":300,"description":"What the step looks like done.","isRequired":true,"uniqueKey":"task.plan.oneOf.0.items.[INDEX].outcome","typeLabel":"string"}},"uniqueKey":"task.plan.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"task.plan.oneOf.0","typeLabel":"object[]"},{"type":"null","minItems":2,"maxItems":8,"description":"The steps Mist planned for the work when Cowork made it from a chat, in order, or null when there is no plan: work with a single step has none. A proposal of how the work goes; nothing in it has been approved or done.","items":{"type":"object","additionalProperties":false,"required":["title","outcome"],"properties":{"title":{"type":"string","maxLength":120},"outcome":{"type":"string","maxLength":300,"description":"What the step looks like done."}}},"isRequired":true,"uniqueKey":"task.plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.plan","typeLabel":"object[] | null"},"board_position":{"oneOf":[{"type":"string","pattern":"^[0-9A-Za-z]+$","maxLength":255,"description":"Where the work sits on the board, as a canonical fractional index in base-62 digits (the fractional-indexing format: the first character gives the integer part's length and the fraction never ends in 0) that sorts as a plain string. One order for the whole board, which each column draws its cards in; equal positions are ordered by id. Null until someone places it; a board draws unplaced work newest first.","isRequired":true,"uniqueKey":"task.board_position.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9A-Za-z]+$","maxLength":255,"description":"Where the work sits on the board, as a canonical fractional index in base-62 digits (the fractional-indexing format: the first character gives the integer part's length and the fraction never ends in 0) that sorts as a plain string. One order for the whole board, which each column draws its cards in; equal positions are ordered by id. Null until someone places it; a board draws unplaced work newest first.","isRequired":true,"uniqueKey":"task.board_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.board_position","typeLabel":"string | null"},"board_position_at_ms":{"oneOf":[{"type":"integer","description":"When the board position was last written, in Unix milliseconds. The position is its own register: a client folding two readings of the same work keeps the position with the newer stamp, whatever their lock_version, since placing work never changes it. Null until someone places the work.","isRequired":true,"uniqueKey":"task.board_position_at_ms.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When the board position was last written, in Unix milliseconds. The position is its own register: a client folding two readings of the same work keeps the position with the newer stamp, whatever their lock_version, since placing work never changes it. Null until someone places the work.","isRequired":true,"uniqueKey":"task.board_position_at_ms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.board_position_at_ms","typeLabel":"integer | null"},"lock_version":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"task.lock_version","typeLabel":"integer"},"run_id":{"oneOf":[{"type":"string","description":"The owning runtime identity, when work has a recorded run.","isRequired":true,"uniqueKey":"task.run_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The owning runtime identity, when work has a recorded run.","isRequired":true,"uniqueKey":"task.run_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.run_id","typeLabel":"string | null"},"run_thread_id":{"oneOf":[{"type":"integer","description":"Row id of the discussion the current run will answer, chosen from this task's own source_threads when the run was claimed and released with it. Never anything else, and not reconciled afterwards: a destination unlinked or deleted while the run is out keeps its id here and stops being listed in source_threads. That run then finishes without a reply, and one arriving with a reply is refused for having no discussion to answer.","isRequired":true,"uniqueKey":"task.run_thread_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Row id of the discussion the current run will answer, chosen from this task's own source_threads when the run was claimed and released with it. Never anything else, and not reconciled afterwards: a destination unlinked or deleted while the run is out keeps its id here and stops being listed in source_threads. That run then finishes without a reply, and one arriving with a reply is refused for having no discussion to answer.","isRequired":true,"uniqueKey":"task.run_thread_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.run_thread_id","typeLabel":"integer | null"},"tags":{"type":"array","uniqueItems":true,"description":"Tag keys on the work, each at most once. No key is supported, so this is empty; work is sent to an agency through `agency`. (`fluid_studios` once marked work waiting for Fluid Studios.) Clients show a key they do not know as unsupported rather than dropping it.","items":{"type":"string","uniqueKey":"task.tags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"task.tags","typeLabel":"string[]"},"agency":{"oneOf":[{"type":"object","description":"The agency the work is sent to, or null when it is sent to none. Set by sending it (POST /tasks/{id}/agency-requests) and cleared by withdrawing it. An agency that has since been discarded is still named.","required":["key","name"],"example":{"key":"example_agency","name":"Example agency"},"properties":{"key":{"type":"string","pattern":"^[a-z0-9_]+$","description":"The agency's permanent key.","isRequired":true,"uniqueKey":"task.agency.oneOf.0.key","typeLabel":"string"},"name":{"type":"string","description":"The name to show.","isRequired":true,"uniqueKey":"task.agency.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task.agency.oneOf.0","typeLabel":"object"},{"type":"null","description":"The agency the work is sent to, or null when it is sent to none. Set by sending it (POST /tasks/{id}/agency-requests) and cleared by withdrawing it. An agency that has since been discarded is still named.","isRequired":true,"uniqueKey":"task.agency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency","typeLabel":"object | null"},"assignee":{"oneOf":[{"type":"object","description":"Who owns the work now, or null for nobody.","required":["id","name","kind"],"properties":{"id":{"type":"string","description":"The user id as a string, or `mist` for the agent.","isRequired":true,"uniqueKey":"task.assignee.oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The name the server attributed, falling back to the email address.","isRequired":true,"uniqueKey":"task.assignee.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name the server attributed, falling back to the email address.","isRequired":true,"uniqueKey":"task.assignee.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.assignee.oneOf.0.name","typeLabel":"string | null"},"kind":{"type":"string","enum":["user","agent"],"description":"Whether this is a person or the agent.","isRequired":true,"uniqueKey":"task.assignee.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"task.assignee.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who owns the work now, or null for nobody.","isRequired":true,"uniqueKey":"task.assignee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.assignee","typeLabel":"object | null"},"assigner":{"oneOf":[{"type":"object","description":"Who handed the work over, kept after it comes back, or null.","required":["id","name","kind"],"properties":{"id":{"type":"string","description":"The user id as a string, or `mist` for the agent.","isRequired":true,"uniqueKey":"task.assigner.oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The name the server attributed, falling back to the email address.","isRequired":true,"uniqueKey":"task.assigner.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name the server attributed, falling back to the email address.","isRequired":true,"uniqueKey":"task.assigner.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.assigner.oneOf.0.name","typeLabel":"string | null"},"kind":{"type":"string","enum":["user","agent"],"description":"Whether this is a person or the agent.","isRequired":true,"uniqueKey":"task.assigner.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"task.assigner.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who handed the work over, kept after it comes back, or null.","isRequired":true,"uniqueKey":"task.assigner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.assigner","typeLabel":"object | null"},"source_threads":{"type":"array","description":"The preview discussions this work came from, oldest first. A summary only: enough to draw a card and open the thread, never what was said.","items":{"type":"object","description":"A preview discussion that contributes to a task, without its content.","required":["id","theme_id","client_id","n","page_url","author_name"],"properties":{"id":{"type":"integer","description":"The discussion's row id.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].id","typeLabel":"integer"},"theme_id":{"type":"integer","description":"The theme the discussion is pinned on. Reading it needs the theme's own permission.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].theme_id","typeLabel":"integer"},"client_id":{"type":"string","description":"The client-generated id the preview clients address the discussion by.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].client_id","typeLabel":"string"},"n":{"oneOf":[{"type":"integer","description":"Display number shown on the pin. A label rather than an identifier.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].n.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Display number shown on the pin. A label rather than an identifier.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].n.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].n","typeLabel":"integer | null"},"page_url":{"oneOf":[{"type":"string","description":"Normalized path of the page the discussion was pinned on.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].page_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Normalized path of the page the discussion was pinned on.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].page_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].page_url","typeLabel":"string | null"},"author_name":{"oneOf":[{"type":"string","description":"Who pinned it, attributed by the server.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].author_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Who pinned it, attributed by the server.","isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].author_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.source_threads.items.[INDEX].author_name","typeLabel":"string | null"}},"uniqueKey":"task.source_threads.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"task.source_threads","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.updated_at","typeLabel":"string\u003cdate-time>"},"mist_confidence":{"type":"object","description":"Mist's confidence that it could do the work as written, scored from the task's title, request, kind and plan before work starts. Present on the task list, a task, a write that answers with the task, and the board; absent where a task is embedded elsewhere. It only informs: no status, assignment, run or Start reads it. The state is derived from saved assessments and the task's current content, never from a queue.","required":["state"],"properties":{"state":{"type":"string","enum":["current","failed","out_of_date","assessing","not_assessed"],"description":"current: a score read the task's current content. failed: the newest attempt at the current content saved no score. out_of_date: the newest score read content the task no longer has, and a new one is on its way. assessing: no score yet, and one is on its way. A score is on its way only for work that has not started and was written to in the last 35 minutes. not_assessed: nothing is on its way: Cowork is off, work has started, or the task has not been written to since before assessment existed. The newest score, if any, comes with it.","isRequired":true,"uniqueKey":"task.mist_confidence.state","typeLabel":"enum\u003cstring>"},"score":{"type":"integer","minimum":1,"maximum":5,"description":"The newest score, from 1 to 5. Absent until one exists.","uniqueKey":"task.mist_confidence.score","typeLabel":"integer"},"band":{"type":"string","enum":["red","yellow","green"],"description":"The color the score reads as, decided by the server from the score alone, 1-2 red, 3 yellow, 4-5 green.","uniqueKey":"task.mist_confidence.band","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","maxLength":280,"description":"Why the work earns the score, in at most two short sentences.","uniqueKey":"task.mist_confidence.summary","typeLabel":"string"},"concerns":{"type":"array","maxItems":3,"description":"What holds the score back. A score below 5 has at least one.","items":{"type":"string","maxLength":200,"uniqueKey":"task.mist_confidence.concerns.items.[INDEX]","typeLabel":"string"},"uniqueKey":"task.mist_confidence.concerns","typeLabel":"string[]"},"raise_by":{"type":"array","maxItems":3,"description":"What the person could add or decide that would raise the score.","items":{"type":"string","maxLength":200,"uniqueKey":"task.mist_confidence.raise_by.items.[INDEX]","typeLabel":"string"},"uniqueKey":"task.mist_confidence.raise_by","typeLabel":"string[]"},"assessed_at":{"type":"string","format":"date-time","description":"When the newest score was saved.","uniqueKey":"task.mist_confidence.assessed_at","typeLabel":"string\u003cdate-time>"},"failure":{"type":"string","enum":["budget","provider","invalid_reply"],"description":"Why the newest attempt at the current content saved no score: the company's Mist budget refused it, the model call failed, or the reply did not meet the contract. Present only in the failed state.","uniqueKey":"task.mist_confidence.failure","typeLabel":"enum\u003cstring>"},"assessment_id":{"type":"string","format":"uuid","description":"The read the newest score came from. Answers to its questions name it. Present whenever score is.","uniqueKey":"task.mist_confidence.assessment_id","typeLabel":"string\u003cuuid>"},"suggested_kind":{"type":"string","enum":["bug","change","feature","design","support"],"description":"The kind of work Mist reads the task as. It never sets the task's kind; a person takes it with an ordinary kind update. This and the other triage fields come together, and only for a read that carries a triage: reads from before triage have none of them.","uniqueKey":"task.mist_confidence.suggested_kind","typeLabel":"enum\u003cstring>"},"category":{"type":"string","enum":["design","support","eng"],"description":"The department the suggested kind belongs to, derived from it - design, support, or eng for bugs, changes and features.","uniqueKey":"task.mist_confidence.category","typeLabel":"enum\u003cstring>"},"difficulty":{"type":"string","enum":["easy","medium","hard"],"description":"How hard Mist rates the work.","uniqueKey":"task.mist_confidence.difficulty","typeLabel":"enum\u003cstring>"},"hours_low":{"type":"integer","minimum":1,"maximum":160,"description":"The low end of the whole hours a skilled person would take. Hours, never money.","uniqueKey":"task.mist_confidence.hours_low","typeLabel":"integer"},"hours_high":{"type":"integer","minimum":1,"maximum":160,"description":"The high end of the hours range, no less than hours_low.","uniqueKey":"task.mist_confidence.hours_high","typeLabel":"integer"},"questions":{"type":"array","maxItems":3,"description":"What Mist needs to know from the task's creator, only when the read found something missing; empty for a read of 4 or 5. Answers go to answerMultiplayerTaskAssessment.","items":{"type":"object","description":"One question Mist asked in a read, answerable in a sentence or by picking an option.","required":["id","prompt","options"],"properties":{"id":{"type":"string","enum":["q1","q2","q3"],"description":"The question's id within its read, in the order asked.","isRequired":true,"uniqueKey":"task.mist_confidence.questions.items.[INDEX].id","typeLabel":"enum\u003cstring>"},"prompt":{"type":"string","maxLength":200,"description":"The question.","isRequired":true,"uniqueKey":"task.mist_confidence.questions.items.[INDEX].prompt","typeLabel":"string"},"options":{"type":"array","maxItems":4,"description":"Likely answers to pick from; empty when the answer is free text.","items":{"type":"string","maxLength":80,"uniqueKey":"task.mist_confidence.questions.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"task.mist_confidence.questions.items.[INDEX].options","typeLabel":"string[]"}},"uniqueKey":"task.mist_confidence.questions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"task.mist_confidence.questions","typeLabel":"object[]"},"duplicate_of":{"type":"object","description":"An older open ticket of the same company that Mist read this one as a repeat of (features/cowork, Phase 026). Present only while the suggestion stands: the state is `current`, the work has not started, the read named the ticket, the company has Cowork on, the other ticket still exists and is not closed, and nobody has merged or dismissed the pair. The key is absent, not null, otherwise. A suggestion informs and never merges: POST .../assessments/{assessment_id}/merge and .../dismiss are the person's.","required":["id","title","status","reason","merge_blocked"],"properties":{"id":{"type":"string","format":"uuid","description":"The older ticket.","isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.title","typeLabel":"string"},"status":{"type":"string","enum":["open","kept","needs_info","in_progress","handed","review"],"description":"The older ticket's status now.","isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.status","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","maxLength":200,"description":"One sentence of why Mist thinks the two repeat each other.","isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.reason","typeLabel":"string"},"merge_blocked":{"oneOf":[{"type":"string","description":"Why a merge into the older ticket would be refused now, or null. `agency`: it is sent to an agency. `running`: a Mist run holds it. `review`: it is in Review, whether or not a run put it there. `result`: it carries a run's result. The link is shown either way.","enum":["agency","running","review","result"],"isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.merge_blocked.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why a merge into the older ticket would be refused now, or null. `agency`: it is sent to an agency. `running`: a Mist run holds it. `review`: it is in Review, whether or not a run put it there. `result`: it carries a run's result. The link is shown either way.","isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.merge_blocked.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.mist_confidence.duplicate_of.merge_blocked","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"task.mist_confidence.duplicate_of","typeLabel":"object"}},"uniqueKey":"task.mist_confidence","typeLabel":"object"},"source":{"oneOf":[{"type":"object","description":"Where the work came from when an outside work tool sent it, such as a Linear issue someone labelled Cowork, else null for work made in Fluid. Present on every full card while Cowork's Linear connector is released for the company: the task list, a task, the answers to task writes, duplicate merges, dismissals and splits, and agency asks, and the board. The key is left out, not null, on the brief cards of refusals and run flows, and for a company without the connector. Read only: Fluid never writes back to the outside tool.","required":["provider","identifier","url"],"properties":{"provider":{"type":"string","enum":["linear"],"description":"The outside work tool.","isRequired":true,"uniqueKey":"task.source.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"identifier":{"type":"string","description":"The issue's identifier in that tool, such as ACM-482.","isRequired":true,"uniqueKey":"task.source.oneOf.0.identifier","typeLabel":"string"},"url":{"type":"string","description":"Link to the issue in that tool.","isRequired":true,"uniqueKey":"task.source.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"task.source.oneOf.0","typeLabel":"object"},{"type":"null","description":"Where the work came from when an outside work tool sent it, such as a Linear issue someone labelled Cowork, else null for work made in Fluid. Present on every full card while Cowork's Linear connector is released for the company: the task list, a task, the answers to task writes, duplicate merges, dismissals and splits, and agency asks, and the board. The key is left out, not null, on the brief cards of refusals and run flows, and for a company without the connector. Read only: Fluid never writes back to the outside tool.","uniqueKey":"task.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.source","typeLabel":"object | null"},"attachment_count":{"type":"integer","minimum":0,"description":"How many images and files the work holds. Present on the cards of the task list, a task, task writes, Mist's answers and assessments, and the board while the company has Cowork and ticket attachments are released for it; left out otherwise.","uniqueKey":"task.attachment_count","typeLabel":"integer"},"agency_request":{"oneOf":[{"type":"object","description":"Where the work stands with its agency: the open request, else the latest request when it closed as declined or done, else null. Present on the task list, a single task, and the writes the task routes themselves answer (creating and changing a task, and sending, withdrawing and answering its agency request), including the task in a 409 or 422. The key is left out, not null, on other responses that carry a task: assessments and their answers, discussion decisions, task links and reviews, the board, and the agency's own read; read the task to see it. It names the agency and carries no agency member, owner, pick-up or time. A client sends its `version` as `expected_version` when it answers a quote or finished work.","required":["agency","state","stage","version","sent_at","quote","revised_quote","changes_round","reopenable_until","delivery_overdue","last_step","owner","access","owner_has_access"],"properties":{"agency":{"type":"object","description":"An agency a customer can send work to, by the permanent key that names it in requests and the name people read. Agencies are records a root admin creates; no client names one in code.","required":["key","name"],"properties":{"key":{"type":"string","pattern":"^[a-z0-9_]+$","description":"The agency's permanent key.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.agency.key","typeLabel":"string"},"name":{"type":"string","description":"The name to show.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.agency.name","typeLabel":"string"}},"examples":[{"key":"example_agency","name":"Example agency"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.agency","typeLabel":"object"},"owner":{"oneOf":[{"type":"object","description":"The agency member who picked the ticket up, who is the person to give access to by default. It is the only agency person the customer's read names apart from those given access. Null while nobody has picked it up, when the member's account is gone, and once the request is not open.","required":["id","name"],"properties":{"id":{"type":"string","description":"The user id as a string.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","description":"The member's name, or `Unnamed person`. It never falls back to their email.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","description":"The agency member who picked the ticket up, who is the person to give access to by default. It is the only agency person the customer's read names apart from those given access. Null while nobody has picked it up, when the member's account is gone, and once the request is not open.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner","typeLabel":"object | null"},"access":{"type":"array","description":"The agency people the customer gave access to their store from this ticket, each with the role they hold, ordered by name. Shown only to a reader who may manage that access (`users.update`, as `POST /agency-request/access` asks); any other reader gets an empty list, however many people were given access. Empty once the request is not open.","items":{"type":"object","description":"An agency person given access to a company's store from a ticket, and their role. The customer's read lists them for a reader who may manage access; an agency member's read carries only their own.","required":["person","role"],"properties":{"person":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The user id as a string.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].person.id","typeLabel":"string"},"name":{"type":"string","description":"The person's name, or `Unnamed person`. It never falls back to their email.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].person.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].person","typeLabel":"object"},"role":{"oneOf":[{"type":"object","description":"The role the person's admin holds, or null for an admin with no role.","required":["id","name"],"properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].role.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].role.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].role.oneOf.0","typeLabel":"object"},{"type":"null","description":"The role the person's admin holds, or null for an admin with no role.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX].role","typeLabel":"object | null"}},"uniqueKey":"task.agency_request.oneOf.0.access.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.access","typeLabel":"object[]"},"owner_has_access":{"type":"boolean","description":"Whether the agency member who picked the ticket up can get into the store: they were given access here, or hold an admin of their own. False while nobody has picked it up, and once the request is not open. Every reader sees it, whether or not they may manage access.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.owner_has_access","typeLabel":"boolean"},"state":{"type":"string","enum":["sent","declined","done"],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.state","typeLabel":"enum\u003cstring>"},"stage":{"type":"string","enum":["requested","quoted","accepted","done_proposed"],"description":"`requested` waits for the agency's quote, `quoted` for the customer's answer, `accepted` is being built, and `done_proposed` waits for the customer to accept the work.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.stage","typeLabel":"enum\u003cstring>"},"version":{"type":"integer","minimum":0,"description":"The request's version, sent back as `expected_version` by the answers.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.version","typeLabel":"integer"},"sent_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.sent_at","typeLabel":"string\u003cdate-time>"},"quote":{"oneOf":[{"type":"object","description":"The current quote, or null while no quote stands.","required":["hours","deliver_on","note","quoted_at"],"properties":{"hours":{"type":"number","description":"The agency's estimate in hours. It is not a price.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.hours","typeLabel":"number"},"deliver_on":{"type":"string","format":"date","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.deliver_on","typeLabel":"string\u003cdate>"},"note":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.note","typeLabel":"string | null"},"quoted_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0.quoted_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.0","typeLabel":"object"},{"type":"null","description":"The current quote, or null while no quote stands.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.quote","typeLabel":"object | null"},"revised_quote":{"oneOf":[{"type":"object","description":"The quote the agency revised while building, waiting for the customer's answer (accept-revision or decline-revision), or null when none waits.","required":["hours","deliver_on","note","quoted_at"],"properties":{"hours":{"type":"number","description":"The agency's estimate in hours. It is not a price.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.hours","typeLabel":"number"},"deliver_on":{"type":"string","format":"date","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.deliver_on","typeLabel":"string\u003cdate>"},"note":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.note","typeLabel":"string | null"},"quoted_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0.quoted_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.0","typeLabel":"object"},{"type":"null","description":"The quote the agency revised while building, waiting for the customer's answer (accept-revision or decline-revision), or null when none waits.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.revised_quote","typeLabel":"object | null"},"changes_round":{"type":"integer","minimum":0,"description":"How many times the customer has asked this agency for changes on the request.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.changes_round","typeLabel":"integer"},"reopenable_until":{"oneOf":[{"type":"string","format":"date-time","description":"Until when finished work (`state` `done`) may be reopened, 14 days after it was accepted. Null for any other request and once the time has passed.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.reopenable_until.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Until when finished work (`state` `done`) may be reopened, 14 days after it was accepted. Null for any other request and once the time has passed.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.reopenable_until.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.reopenable_until","typeLabel":"string\u003cdate-time> | null"},"delivery_overdue":{"type":"boolean","description":"True while the agency is still building (`stage` `accepted`) after the delivery date of the current quote, which is before today in UTC. False for any other request.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.delivery_overdue","typeLabel":"boolean"},"last_step":{"oneOf":[{"type":"object","description":"The latest step on the request, or null for a request nobody has stepped on.","required":["kind","at","note"],"properties":{"kind":{"type":"string","description":"One of `sent`, `quoted`, `declined`, `quote_accepted`, `quote_declined`, `done_proposed`, `work_accepted`, `work_refused`, `withdrawn`, `quote_revised`, `revision_accepted`, `revision_declined`, `reopened`, `done_reminded`, `quote_reminded` or `delivery_missed`. A client treats a kind it does not know as a step it cannot name.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0.kind","typeLabel":"string"},"at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"note":{"oneOf":[{"type":"string","description":"The quote or done note, or the reason a step gave.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","description":"The quote or done note, or the reason a step gave.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0.note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0.note","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.0","typeLabel":"object"},{"type":"null","description":"The latest step on the request, or null for a request nobody has stepped on.","isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_request.oneOf.0.last_step","typeLabel":"object | null"}},"uniqueKey":"task.agency_request.oneOf.0","typeLabel":"object"},{"type":"null","description":"Where the work stands with its agency: the open request, else the latest request when it closed as declined or done, else null. Present on the task list, a single task, and the writes the task routes themselves answer (creating and changing a task, and sending, withdrawing and answering its agency request), including the task in a 409 or 422. The key is left out, not null, on other responses that carry a task: assessments and their answers, discussion decisions, task links and reviews, the board, and the agency's own read; read the task to see it. It names the agency and carries no agency member, owner, pick-up or time. A client sends its `version` as `expected_version` when it answers a quote or finished work.","uniqueKey":"task.agency_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.agency_request","typeLabel":"object | null"},"agency_join_request":{"oneOf":[{"type":"object","description":"Where the work stands with an ask for an agency Fluid does not have yet (POST /tasks/{id}/agency-join-requests): the pending request, else the latest one Fluid declined while the work has no agency and no newer request, else null. An approved request is not shown (the work's `agency` says it), and neither is a cancelled one. Present wherever `agency_request` is, and left out, not null, wherever that is. It names the agency asked for, the state and the decline reason, and never the contact email, the note or who decided. A client sends its `lock_version` as `expected_version` when it cancels the request.","required":["id","state","agency_name","decline_reason","requested_at","lock_version"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.id","typeLabel":"string\u003cuuid>"},"state":{"type":"string","enum":["pending","declined"],"isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.state","typeLabel":"enum\u003cstring>"},"agency_name":{"type":"string","description":"The name of the agency the customer asked for.","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.agency_name","typeLabel":"string"},"decline_reason":{"oneOf":[{"type":"string","description":"Why Fluid declined, or null while the request is pending.","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why Fluid declined, or null while the request is pending.","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.decline_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.decline_reason","typeLabel":"string | null"},"requested_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.requested_at","typeLabel":"string\u003cdate-time>"},"lock_version":{"type":"integer","minimum":0,"description":"The request's version, sent back as `expected_version` when it is cancelled.","isRequired":true,"uniqueKey":"task.agency_join_request.oneOf.0.lock_version","typeLabel":"integer"}},"uniqueKey":"task.agency_join_request.oneOf.0","typeLabel":"object"},{"type":"null","description":"Where the work stands with an ask for an agency Fluid does not have yet (POST /tasks/{id}/agency-join-requests): the pending request, else the latest one Fluid declined while the work has no agency and no newer request, else null. An approved request is not shown (the work's `agency` says it), and neither is a cancelled one. Present wherever `agency_request` is, and left out, not null, wherever that is. It names the agency asked for, the state and the decline reason, and never the contact email, the note or who decided. A client sends its `lock_version` as `expected_version` when it cancels the request.","uniqueKey":"task.agency_join_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.agency_join_request","typeLabel":"object | null"},"merged_into":{"oneOf":[{"type":"object","description":"The ticket this one was merged into, or null for a ticket that is not merged (features/cowork, Phase 026). A merged ticket is `skipped`, frozen and has nothing to do but Split (POST /tasks/{id}/split). A deleted target is drawn with `deleted: true`, so the ticket can still be split. Present wherever `mist_confidence` is, and left out, not null, wherever that is.","required":["id","title","deleted"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.merged_into.oneOf.0.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"task.merged_into.oneOf.0.title","typeLabel":"string"},"deleted":{"type":"boolean","description":"Whether the target was deleted since. A merged ticket can still be split then.","isRequired":true,"uniqueKey":"task.merged_into.oneOf.0.deleted","typeLabel":"boolean"}},"uniqueKey":"task.merged_into.oneOf.0","typeLabel":"object"},{"type":"null","description":"The ticket this one was merged into, or null for a ticket that is not merged (features/cowork, Phase 026). A merged ticket is `skipped`, frozen and has nothing to do but Split (POST /tasks/{id}/split). A deleted target is drawn with `deleted: true`, so the ticket can still be split. Present wherever `mist_confidence` is, and left out, not null, wherever that is.","uniqueKey":"task.merged_into.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.merged_into","typeLabel":"object | null"},"merged_from":{"type":"array","description":"The tickets merged into this one, oldest merge first; empty when nothing was merged in. A merged ticket that was deleted is left out. Present wherever `mist_confidence` is, and left out wherever that is.","items":{"type":"object","description":"A ticket merged into the one that carries this list.","required":["id","title","merged_at","version"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.merged_from.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"task.merged_from.items.[INDEX].title","typeLabel":"string"},"merged_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.merged_from.items.[INDEX].merged_at","typeLabel":"string\u003cdate-time>"},"version":{"type":"integer","minimum":0,"description":"The merged ticket's `lock_version`, for a client's own cache. Split takes no version.","isRequired":true,"uniqueKey":"task.merged_from.items.[INDEX].version","typeLabel":"integer"}},"uniqueKey":"task.merged_from.items.[INDEX]","typeLabel":"object"},"uniqueKey":"task.merged_from","typeLabel":"object[]"},"conversation_id":{"oneOf":[{"type":"integer","description":"The id of the ticket's messaging channel, the conversation in the company where the customer talks about the ticket, or null before the ticket's first send to an agency. A switch to another agency keeps it. Present only for a company with the COWORK feature flag on, and then wherever `agency_request` is; left out, not null, otherwise. Whether the reader may open the channel is up to Messaging.","uniqueKey":"task.conversation_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The id of the ticket's messaging channel, the conversation in the company where the customer talks about the ticket, or null before the ticket's first send to an agency. A switch to another agency keeps it. Present only for a company with the COWORK feature flag on, and then wherever `agency_request` is; left out, not null, otherwise. Whether the reader may open the channel is up to Messaging.","uniqueKey":"task.conversation_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.conversation_id","typeLabel":"integer | null"},"status_editable":{"type":"boolean","description":"Whether the viewer may move this task's status now: the status rules hold (not sent to an agency; assigned to nobody or to the viewer; in a company without Cowork, always), Mist is not running it, and the viewer holds multiplayer_tasks.update or application_themes.update. Per viewer, so a client does not derive it. Present on the cards of the task list, a single task and the writes the task routes answer, wherever `agency_request` is, and left out, not false, wherever that is and for a caller that is not a user session. The status route still decides: this is a hint for the control, not the check.","uniqueKey":"task.status_editable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"task","typeLabel":"object"},"status":{"const":200,"isRequired":true,"uniqueKey":"status","typeLabel":"any"},"meta":{"type":"object","required":["request_uuid","timestamp"],"properties":{"request_uuid":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.request_uuid","typeLabel":"string | null"},"timestamp":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"task":{"id":"01a1d0e3-e17a-7dcb-aaf7-471e531566c2","agency":null,"agency_join_request":null,"agency_request":null,"assignee":null,"assigner":null,"board_position":"a0V","board_position_at_ms":1789000000000,"category":null,"client_id":"dup-03fb70b130ea","company_id":96778814,"conversation_id":null,"created_at":"2026-11-12T16:52:37Z","creator_id":433400890,"description":"Pay button dead on my phone","due_on":null,"kind":null,"lock_version":1,"merged_from":[],"merged_into":{"id":"01a1d0e3-e177-7a20-bb9d-f43b802d7615","title":"Place order button does nothing on iPhone","deleted":false},"mist_confidence":{"state":"current","assessment_id":"01a1d0e3-e17c-72cc-b14f-5066a1b1fa37","score":4,"band":"green","summary":"A clear change.","concerns":["Detail"],"raise_by":[],"assessed_at":"2026-11-12T17:52:37.755Z","suggested_kind":"change","category":"eng","difficulty":"easy","hours_low":1,"hours_high":2,"questions":[]},"plan":null,"priority":null,"run_id":null,"run_thread_id":null,"source_threads":[],"status":"skipped","status_editable":true,"tags":[],"title":"Cannot tap pay on my phone","updated_at":"2026-11-12T17:52:37Z"},"status":200,"meta":{"request_uuid":null,"timestamp":"2026-11-12T17:52:37Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fa0d62e7-9942-4ac6-a1a0-b11bdf53b2d3":{"description":"Authentication is required.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1e5a6f92-daaa-4e61-a0de-11b8a7314ae9":{"description":"A user session, company admin status, and planning permission are required.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"225bf07a-6bc6-4db2-9887-f12cb9204911":{"description":"The task is unavailable in this company.","content":{"application/json":{"schema":{"type":"object","required":["error","status","meta"],"properties":{"error":{"type":"object","required":["message","details"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"meta":{"type":"object","required":["request_uuid","timestamp"],"properties":{"request_uuid":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.request_uuid","typeLabel":"string | null"},"timestamp":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","details":{}},"status":123,"meta":{"request_uuid":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ba811672-b025-4b3b-b8b2-a8e57efd7eb6":{"description":"The task was deleted after it was read and before the position landed.","content":{"application/json":{"schema":{"type":"object","required":["error","status","meta"],"properties":{"error":{"type":"object","required":["message","details"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"meta":{"type":"object","required":["request_uuid","timestamp"],"properties":{"request_uuid":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.request_uuid","typeLabel":"string | null"},"timestamp":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","details":{}},"status":123,"meta":{"request_uuid":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ad5780b-6eba-4f28-a044-e3171e7efbe7":{"description":"The position is not a canonical fractional index of at most 255 characters, or the stamp is missing or out of range.","content":{"application/json":{"schema":{"type":"object","required":["error","status","meta"],"properties":{"error":{"type":"object","required":["message","details"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"meta":{"type":"object","required":["request_uuid","timestamp"],"properties":{"request_uuid":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"meta.request_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.request_uuid","typeLabel":"string | null"},"timestamp":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","details":{}},"status":123,"meta":{"request_uuid":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"28ddf9a5-3bae-48be-ba8b-24f4a142065e":{"bearer_auth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"8f48aa1c-b7f3-40fa-b28f-3a6b740a0316":{"url":"https://api.fluid.app"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"api-reference/multiplayer-v2026-04.yaml"},"subdomain":"fluid-090e382c","siteName":"Fluid","title":"Place the company's work on the board - Fluid","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T18:50:19.589Z","originalFileLocation":"api-reference/cowork-tasks/place-the-companys-work-on-the-board.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card\u0026#x27;s new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment\u0026#x27;s: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work\u0026#x27;s linked discussions sit on.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fluid\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Place the company\u0026#x27;s work on the board - Fluid\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card\u0026#x27;s new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment\u0026#x27;s: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work\u0026#x27;s linked discussions sit on.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fluid\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fluid-090e382c.mintlify.site/_mintlify/api/og/v2?division=Cowork+tasks\u0026amp;title=Place+the+company%27s+work+on+the+board\u0026amp;description=Requires+a+user+session+with+multiplayer_tasks.update+or+the+existing+application_themes.update+permission.+Stores+where+the+work+sits+on+the+board%3A+a+canonical\u0026amp;theme=6f09bb706207fa7747f86f05\u0026amp;signature=f8f19d0a83bed091c6b659ec42dd34aa058412d197ff6283c8c4ca7c4c2f96d1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Place the company\u0026#x27;s work on the board - Fluid\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card\u0026#x27;s new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment\u0026#x27;s: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work\u0026#x27;s linked discussions sit on.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fluid-090e382c.mintlify.site/_mintlify/api/og/v2?division=Cowork+tasks\u0026amp;title=Place+the+company%27s+work+on+the+board\u0026amp;description=Requires+a+user+session+with+multiplayer_tasks.update+or+the+existing+application_themes.update+permission.+Stores+where+the+work+sits+on+the+board%3A+a+canonical\u0026amp;theme=6f09bb706207fa7747f86f05\u0026amp;signature=f8f19d0a83bed091c6b659ec42dd34aa058412d197ff6283c8c4ca7c4c2f96d1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fluid-090e382c/Q2m5Ui5LOlWjJ-qB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fluid\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2464ec\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cowork-tasks/place-the-companys-work-on-the-board.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fluid.app/#organization\",\"name\":\"Fluid\",\"url\":\"https://docs.fluid.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fluid-090e382c/AJPEXVHos0QzPSg_/logo.svg?fit=max\u0026auto=format\u0026n=AJPEXVHos0QzPSg_\u0026q=85\u0026s=1c26f326aef44f8645210ea4e7bfdf8b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fluid.app#website\",\"name\":\"Fluid\",\"url\":\"https://docs.fluid.app\",\"publisher\":{\"@id\":\"https://docs.fluid.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board#webpage\",\"url\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board\",\"name\":\"Place the company's work on the board\",\"description\":\"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card's new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment's: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.\",\"dateModified\":\"2026-11-12T18:50:19.589Z\",\"isPartOf\":{\"@id\":\"https://docs.fluid.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cowork\",\"item\":\"https://docs.fluid.app/api-reference/cowork-tasks/read-everything-the-task-board-draws\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cowork tasks\",\"item\":\"https://docs.fluid.app/api-reference/cowork-tasks/read-everything-the-task-board-draws\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Place the company's work on the board\",\"item\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board#apireference\",\"headline\":\"Place the company's work on the board\",\"name\":\"Place the company's work on the board\",\"description\":\"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Stores where the work sits on the board: a canonical fractional index the client computed between the card's new neighbours, so moving one card rewrites only that card, or null to take it out of the order. A key that is not canonical is refused, so the order can always be extended; a client whose next key would pass 255 characters rewrites the positions around it instead. The position is its own register, stamped by the client like a preview comment's: the newer placement wins, an equal stamp goes to the incoming write, and an older one is discarded and answered with the current task. Placing work never changes its lock_version, so a status, priority, assignment, or run write made at the same moment still lands. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the write lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.\",\"url\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fluid.app/api-reference/cowork-tasks/place-the-companys-work-on-the-board#webpage\"},\"dateModified\":\"2026-11-12T18:50:19.589Z\",\"publisher\":{\"@id\":\"https://docs.fluid.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fluid.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fluid\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Fluid\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cowork-tasks/place-the-companys-work-on-the-board.md","siteName":"Fluid","nav":{"global":null,"tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":"/introduction"}]},{"tab":"Developer Platform","pages":[{"title":"Developer Platform","href":"/quickstart"}]},{"tab":"Themes","pages":[{"title":"Themes","href":"/themes/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Fluid API Reference","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Fluid API Authentication — Token Types and Scopes","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Company and member APIs","sidebarTitle":"Company vs member","href":"/api/company-and-member-apis"}]},{"group":"Storefront","pages":[{"group":"Products","pages":[{"title":"Public Products catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/products","href":"/api-reference/storefront/public-products-catalog"},{"title":"Public Product by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/products/{slug}","href":"/api-reference/storefront/public-product-by-slug"},{"title":"Company Products index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/products","href":"/api-reference/company/company-products-index"},{"title":"Create a Product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/products","href":"/api-reference/company/create-a-product"},{"title":"Company Product show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/products/{id}","href":"/api-reference/company/company-product-show"},{"title":"Update a Product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/products/{id}","href":"/api-reference/company/update-a-product"},{"title":"Destroy a Product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/products/{id}","href":"/api-reference/company/destroy-a-product"},{"title":"Share statistics for a Product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/products/{id}/shares","href":"/api-reference/company/share-statistics-for-a-product"},{"title":"Latest Lighthouse result for a product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/products/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-product"},{"title":"Trigger a Lighthouse scan for a product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/products/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-product"},{"title":"Latest compliance result for a product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/products/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-product"},{"title":"Trigger a compliance scan for a product","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/products/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-product"},{"group":"Product tags","pages":[{"title":"List Tags","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/tags","href":"/api-reference/company-v0/tags/list-tags"},{"title":"Create Tags","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/tags","href":"/api-reference/company-v0/tags/create-tags"},{"title":"Delete a saved tag","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/tags/{id}","href":"/api-reference/company-v0/tags/delete-a-saved-tag"}]},{"group":"Legacy (v0)","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/products","href":"/api-reference/company-v0/products/list-products"},{"title":"Get a product contact share link","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/products/{product_id}/contact_share_link","href":"/api-reference/company-v0/products/get-a-product-contact-share-link"},{"title":"List product leads","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/products/{product_id}/leads","href":"/api-reference/company-v0/products/list-product-leads"},{"title":"Get the price for a selected variant","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/products/{product_id}/selected_variant_price","href":"/api-reference/company-v0/products/get-the-price-for-a-selected-variant"},{"title":"List product views","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/products/{product_id}/views","href":"/api-reference/company-v0/products/list-product-views"},{"title":"List filtered products","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/v1.1/products","href":"/api-reference/company-v0/products/list-filtered-products"}]}]},{"group":"Enrollment packs","pages":[{"title":"Public Enrollment Packs catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/enrollment-packs","href":"/api-reference/storefront/public-enrollment-packs-catalog"},{"title":"Public Enrollment Pack by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/enrollment-packs/{slug}","href":"/api-reference/storefront/public-enrollment-pack-by-slug"},{"title":"Company Enrollment Packs index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/enrollment-packs","href":"/api-reference/company/company-enrollment-packs-index"},{"title":"Create an Enrollment Pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/enrollment-packs","href":"/api-reference/company/create-an-enrollment-pack"},{"title":"Company Enrollment Pack show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/enrollment-packs/{id}","href":"/api-reference/company/company-enrollment-pack-show"},{"title":"Update an Enrollment Pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/enrollment-packs/{id}","href":"/api-reference/company/update-an-enrollment-pack"},{"title":"Destroy an Enrollment Pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/enrollment-packs/{id}","href":"/api-reference/company/destroy-an-enrollment-pack"},{"title":"Share statistics for an Enrollment Pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/enrollment-packs/{id}/shares","href":"/api-reference/company/share-statistics-for-an-enrollment-pack"},{"title":"Latest Lighthouse result for an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/enrollment-packs/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-an-enrollment-pack"},{"title":"Trigger a Lighthouse scan for an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/enrollment-packs/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-an-enrollment-pack"},{"title":"Latest compliance result for an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/enrollment-packs/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-an-enrollment-pack"},{"title":"Trigger a compliance scan for an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/enrollment-packs/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-an-enrollment-pack"},{"group":"Legacy (v0)","pages":[{"title":"List all enrollment packs","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/enrollment_packs","href":"/api-reference/company-v0/enrollment-packs/list-all-enrollment-packs"},{"title":"Create a new enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/enrollment_packs","href":"/api-reference/company-v0/enrollment-packs/create-a-new-enrollment-pack"},{"title":"Bulk update enrollment pack status","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/enrollment_packs/bulk_status_update","href":"/api-reference/company-v0/enrollment-packs/bulk-update-enrollment-pack-status"},{"title":"Retrieves a specific enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/enrollment_packs/{id}","href":"/api-reference/company-v0/enrollment-packs/retrieves-a-specific-enrollment-pack"},{"title":"Delete an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/enrollment_packs/{id}","href":"/api-reference/company-v0/enrollment-packs/delete-an-enrollment-pack"},{"title":"Update an enrollment pack","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/enrollment_packs/{id}","href":"/api-reference/company-v0/enrollment-packs/update-an-enrollment-pack"}]}]},{"group":"Categories","pages":[{"title":"Public Categories catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/categories","href":"/api-reference/storefront/public-categories-catalog"},{"title":"Public Category by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/categories/{slug}","href":"/api-reference/storefront/public-category-by-slug"},{"title":"Products in a Category (public)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/categories/{slug}/products","href":"/api-reference/storefront/products-in-a-category-public"},{"title":"Company Categories index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories","href":"/api-reference/company/company-categories-index"},{"title":"Create a Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/categories","href":"/api-reference/company/create-a-category"},{"title":"Company Category show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories/{id}","href":"/api-reference/company/company-category-show"},{"title":"Update a Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/categories/{id}","href":"/api-reference/company/update-a-category"},{"title":"Destroy a Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/categories/{id}","href":"/api-reference/company/destroy-a-category"},{"title":"Share statistics for a Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories/{id}/shares","href":"/api-reference/company/share-statistics-for-a-category"},{"title":"Products in a Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories/{id}/products","href":"/api-reference/company/products-in-a-category"},{"title":"Latest Lighthouse result for a category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-category"},{"title":"Trigger a Lighthouse scan for a category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/categories/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-category"},{"title":"Latest compliance result for a category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/categories/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-category"},{"title":"Trigger a compliance scan for a category","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/categories/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-category"},{"group":"Legacy (v0)","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/categories","href":"/api-reference/company-v0/categories/list-categories"}]}]},{"group":"Collections","pages":[{"title":"Public Collections catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/collections","href":"/api-reference/storefront/public-collections-catalog"},{"title":"Public Collection by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/collections/{slug}","href":"/api-reference/storefront/public-collection-by-slug"},{"title":"Products in a Collection (public)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/collections/{slug}/products","href":"/api-reference/storefront/products-in-a-collection-public"},{"title":"Company Collections index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections","href":"/api-reference/company/company-collections-index"},{"title":"Create a Collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/collections","href":"/api-reference/company/create-a-collection"},{"title":"Company Collection show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections/{id}","href":"/api-reference/company/company-collection-show"},{"title":"Update a Collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/collections/{id}","href":"/api-reference/company/update-a-collection"},{"title":"Destroy a Collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/collections/{id}","href":"/api-reference/company/destroy-a-collection"},{"title":"Share statistics for a Collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections/{id}/shares","href":"/api-reference/company/share-statistics-for-a-collection"},{"title":"Products in a Collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections/{id}/products","href":"/api-reference/company/products-in-a-collection"},{"title":"Latest Lighthouse result for a collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-collection"},{"title":"Trigger a Lighthouse scan for a collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/collections/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-collection"},{"title":"Latest compliance result for a collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/collections/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-collection"},{"title":"Trigger a compliance scan for a collection","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/collections/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-collection"}]},{"group":"Pages","pages":[{"title":"Public Pages catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/pages","href":"/api-reference/storefront/public-pages-catalog"},{"title":"Public Page by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/pages/{slug}","href":"/api-reference/storefront/public-page-by-slug"},{"title":"Company Pages index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/pages","href":"/api-reference/company/company-pages-index"},{"title":"Create a Page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/pages","href":"/api-reference/company/create-a-page"},{"title":"Company Page show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/pages/{id}","href":"/api-reference/company/company-page-show"},{"title":"Update a Page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/pages/{id}","href":"/api-reference/company/update-a-page"},{"title":"Destroy a Page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/pages/{id}","href":"/api-reference/company/destroy-a-page"},{"title":"Clone a Page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/pages/{id}/clone","href":"/api-reference/company/clone-a-page"},{"title":"Share statistics for a Page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/pages/{id}/shares","href":"/api-reference/company/share-statistics-for-a-page"},{"title":"Latest Lighthouse result for a page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/pages/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-page"},{"title":"Trigger a Lighthouse scan for a page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/pages/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-page"},{"title":"Latest compliance result for a page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/pages/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-page"},{"title":"Trigger a compliance scan for a page","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/pages/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-page"},{"group":"Legacy (v0)","pages":[{"title":"Retrieve a list of company pages","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/pages","href":"/api-reference/company-v0/pages/retrieve-a-list-of-company-pages"},{"title":"Create a new page","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/pages","href":"/api-reference/company-v0/pages/create-a-new-page"},{"title":"Retrieve a single company page","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/pages/{id}","href":"/api-reference/company-v0/pages/retrieve-a-single-company-page"},{"title":"Update a company page","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/pages/{id}","href":"/api-reference/company-v0/pages/update-a-company-page"},{"title":"Delete a company page","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/pages/{id}","href":"/api-reference/company-v0/pages/delete-a-company-page"},{"title":"Append metadata field","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/pages/{id}/append_metadata","href":"/api-reference/company-v0/pages/append-metadata-field"},{"title":"Duplicate a page","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/pages/{id}/duplicate","href":"/api-reference/company-v0/pages/duplicate-a-page"},{"title":"Send a page to the top","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/pages/{id}/send_to_top","href":"/api-reference/company-v0/pages/send-a-page-to-the-top"},{"title":"List page leads","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/page/{id}/leads","href":"/api-reference/company-v0/page/list-page-leads"},{"title":"List page views","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/page/{id}/views","href":"/api-reference/company-v0/page/list-page-views"},{"title":"List pages","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/pages","href":"/api-reference/company-v0/pages/list-pages"}]}]},{"group":"Posts","pages":[{"title":"Public Posts (blog) catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/posts","href":"/api-reference/storefront/public-posts-blog-catalog"},{"title":"Public Post by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/posts/{slug}","href":"/api-reference/storefront/public-post-by-slug"},{"title":"Company Posts index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/posts","href":"/api-reference/company/company-posts-index"},{"title":"Create a Post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/posts","href":"/api-reference/company/create-a-post"},{"title":"Company Post show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/posts/{id}","href":"/api-reference/company/company-post-show"},{"title":"Update a Post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/posts/{id}","href":"/api-reference/company/update-a-post"},{"title":"Destroy a Post (soft-delete)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/posts/{id}","href":"/api-reference/company/destroy-a-post-soft-delete"},{"title":"Share statistics for a Post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/posts/{id}/shares","href":"/api-reference/company/share-statistics-for-a-post"},{"title":"Latest Lighthouse result for a post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/posts/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-post"},{"title":"Trigger a Lighthouse scan for a post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/posts/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-post"},{"title":"Latest compliance result for a post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/posts/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-post"},{"title":"Trigger a compliance scan for a post","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/posts/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-post"}]},{"group":"Playlists","pages":[{"title":"List playlists (public storefront catalog)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/playlists","href":"/api-reference/storefront/list-playlists-public-storefront-catalog"},{"title":"Show a playlist (public, by slug)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/playlists/{slug}","href":"/api-reference/storefront/show-a-playlist-public-by-slug"},{"title":"List playlists (company, authenticated)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/playlists","href":"/api-reference/company/list-playlists-company-authenticated"},{"title":"Create a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/playlists","href":"/api-reference/company/create-a-playlist"},{"title":"Show a playlist (company, by id)","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/playlists/{id}","href":"/api-reference/company/show-a-playlist-company-by-id"},{"title":"Update a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/playlists/{id}","href":"/api-reference/company/update-a-playlist"},{"title":"Soft-delete a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/playlists/{id}","href":"/api-reference/company/soft-delete-a-playlist"},{"title":"Share statistics for a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/playlists/{id}/shares","href":"/api-reference/company/share-statistics-for-a-playlist"},{"title":"Latest Lighthouse result for a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/playlists/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-playlist"},{"title":"Trigger a Lighthouse scan for a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/playlists/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-playlist"},{"title":"Latest compliance result for a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/playlists/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-playlist"},{"title":"Trigger a compliance scan for a playlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/playlists/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-playlist"},{"group":"Legacy (v0)","pages":[{"title":"List Company Libraries","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/libraries","href":"/api-reference/company-v0/libraries/list-company-libraries"},{"title":"Create Company Library","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/libraries","href":"/api-reference/company-v0/libraries/create-company-library"},{"title":"List Available Playlist Resources","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/libraries/available_resources_for_playlists","href":"/api-reference/company-v0/libraries/list-available-playlist-resources"},{"title":"Show a library","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/libraries/{id}","href":"/api-reference/company-v0/libraries/show-a-library"},{"title":"Clone Company Library","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/libraries/{id}/clone_company_library","href":"/api-reference/company-v0/libraries/clone-company-library"},{"title":"Delete Library Item","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/libraries/{id}/destroy_library_item","href":"/api-reference/company-v0/libraries/delete-library-item"},{"title":"Add Item to Library","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/libraries/{library_id}/add_item_to_library","href":"/api-reference/company-v0/libraries/add-item-to-library"}]}]},{"group":"Media","pages":[{"title":"Public Media catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/media","href":"/api-reference/storefront/public-media-catalog"},{"title":"Public Medium by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/media/{slug}","href":"/api-reference/storefront/public-medium-by-slug"},{"title":"Company Media index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/media","href":"/api-reference/company/company-media-index"},{"title":"Create a Medium","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/media","href":"/api-reference/company/create-a-medium"},{"title":"Company Medium show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/media/{id}","href":"/api-reference/company/company-medium-show"},{"title":"Update a Medium","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/media/{id}","href":"/api-reference/company/update-a-medium"},{"title":"Destroy a Medium","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/media/{id}","href":"/api-reference/company/destroy-a-medium"},{"title":"Share statistics for a Medium","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/media/{id}/shares","href":"/api-reference/company/share-statistics-for-a-medium"},{"title":"Latest Lighthouse result for a media item","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/media/{id}/lighthouse","href":"/api-reference/company/latest-lighthouse-result-for-a-media-item"},{"title":"Trigger a Lighthouse scan for a media item","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/media/{id}/lighthouse","href":"/api-reference/company/trigger-a-lighthouse-scan-for-a-media-item"},{"title":"Latest compliance result for a media item","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/media/{id}/compliance","href":"/api-reference/company/latest-compliance-result-for-a-media-item"},{"title":"Trigger a compliance scan for a media item","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/media/{id}/compliance","href":"/api-reference/company/trigger-a-compliance-scan-for-a-media-item"},{"group":"Legacy (v0)","pages":[{"title":"List company media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/media","href":"/api-reference/company-v0/media/list-company-media"},{"title":"Create company media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/media","href":"/api-reference/company-v0/media/create-company-media"},{"title":"Get company media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/media/{id}","href":"/api-reference/company-v0/media/get-company-media"},{"title":"Delete company media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/media/{id}","href":"/api-reference/company-v0/media/delete-company-media"},{"title":"Update company media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/media/{id}","href":"/api-reference/company-v0/media/update-company-media"},{"title":"Send Media Notifications to Affiliates","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/media/{id}/send_notifications","href":"/api-reference/company-v0/media/send-media-notifications-to-affiliates"},{"title":"Send media to top","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/media/{id}/send_to_top","href":"/api-reference/company-v0/media/send-media-to-top"},{"title":"Create a media comment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/media/{id}/comment","href":"/api-reference/company-v0/media/create-a-media-comment"},{"title":"List external media comments","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{id}/external_comments","href":"/api-reference/company-v0/media/list-external-media-comments"},{"title":"List internal media comments","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{id}/internal_comments","href":"/api-reference/company-v0/media/list-internal-media-comments"},{"title":"List media reactions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{id}/reactions","href":"/api-reference/company-v0/media/list-media-reactions"},{"title":"Record a media watch with GET","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{id}/watch","href":"/api-reference/company-v0/media/record-a-media-watch-with-get"},{"title":"Record a media watch","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/media/{id}/watch","href":"/api-reference/company-v0/media/record-a-media-watch"},{"title":"List media watches","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{id}/watches","href":"/api-reference/company-v0/media/list-media-watches"},{"title":"List media leads","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{medium_id}/leads","href":"/api-reference/company-v0/media/list-media-leads"},{"title":"List media views","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/media/{medium_id}/views","href":"/api-reference/company-v0/media/list-media-views"},{"title":"List filtered media","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/v1.1/media","href":"/api-reference/company-v0/media/list-filtered-media"}]}]},{"group":"Sites","pages":[{"title":"A member's public sites","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/credits/{credit}/sites","href":"/api-reference/member-sites/a-members-public-sites"},{"title":"Public Sites catalog","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/sites","href":"/api-reference/sites/public-sites-catalog"},{"title":"Public Site by slug","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/sites/{slug}","href":"/api-reference/sites/public-site-by-slug"},{"title":"Company Sites index","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/sites","href":"/api-reference/sites/company-sites-index"},{"title":"Create a Site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/sites","href":"/api-reference/sites/create-a-site"},{"title":"Company Site show","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/sites/{id}","href":"/api-reference/sites/company-site-show"},{"title":"Update a Site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml patch /api/v202604/company/sites/{id}","href":"/api-reference/sites/update-a-site"},{"title":"Delete a Site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml delete /api/v202604/company/sites/{id}","href":"/api-reference/sites/delete-a-site"},{"title":"Share statistics for a Site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/sites/{id}/shares","href":"/api-reference/sites/share-statistics-for-a-site"},{"title":"Latest Lighthouse result for a site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/sites/{id}/lighthouse","href":"/api-reference/sites/latest-lighthouse-result-for-a-site"},{"title":"Trigger a Lighthouse scan for a site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/sites/{id}/lighthouse","href":"/api-reference/sites/trigger-a-lighthouse-scan-for-a-site"},{"title":"Latest compliance result for a site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/sites/{id}/compliance","href":"/api-reference/sites/latest-compliance-result-for-a-site"},{"title":"Trigger a compliance scan for a site","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml post /api/v202604/company/sites/{id}/compliance","href":"/api-reference/sites/trigger-a-compliance-scan-for-a-site"}]}]},{"group":"Commerce","pages":[{"group":"Orders","pages":[{"title":"List the company's orders","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v2026-04.yaml get /api/v202604/orders","href":"/api-reference/orders/list-the-companys-orders"},{"title":"Count the company's orders","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v2026-04.yaml get /api/v202604/orders/count","href":"/api-reference/orders/count-the-companys-orders"},{"title":"List an order's edits with their before and after snapshots","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v2026-04.yaml get /api/v202604/orders/{order_id}/edits","href":"/api-reference/order_edits/list-an-orders-edits-with-their-before-and-after-snapshots"},{"title":"Atomically apply one or more edits to an existing order","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v2026-04.yaml post /api/v202604/orders/{order_id}/edits","href":"/api-reference/order_edits/atomically-apply-one-or-more-edits-to-an-existing-order"},{"title":"Dry-run an edit and return the would-be order shape","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v2026-04.yaml post /api/v202604/orders/{order_id}/edits/preview","href":"/api-reference/order_edits/dry-run-an-edit-and-return-the-would-be-order-shape"},{"title":"List orders for a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/customers/{customer_id}/orders","href":"/api-reference/customer-orders/list-orders-for-a-customer"},{"title":"List orders for a member","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/members/{member_id}/orders","href":"/api-reference/customer-orders/list-orders-for-a-member"},{"title":"List order change logs","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/order_change_logs","href":"/api-reference/order-change-logs/list-order-change-logs"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders","href":"/api-reference/orders/list-orders"},{"title":"Import an order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/orders","href":"/api-reference/orders/import-an-order"},{"title":"Export orders as CSV","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders/export_csv","href":"/api-reference/orders/export-orders-as-csv"},{"title":"Get order statistics","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders/stats","href":"/api-reference/orders/get-order-statistics"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Preview the points a refund returns","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/orders/{id}/refund-points-preview","href":"/api-reference/orders/preview-the-points-a-refund-returns"},{"title":"Get an order journey","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders/{order_id}/journey","href":"/api-reference/orders/get-an-order-journey"},{"title":"Get order journey events","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/orders/{order_id}/journey/events","href":"/api-reference/orders/get-order-journey-events"},{"title":"List orders (v2)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml get /api/v2/orders","href":"/api-reference/orders/list-orders-v2"},{"title":"Bulk update orders","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/bulk_update","href":"/api-reference/orders/bulk-update-orders"},{"title":"Send invoice email","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml post /api/v2/orders/send_invoice_email","href":"/api-reference/orders/send-invoice-email"},{"title":"Get order statistics (v2)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml get /api/v2/orders/stats","href":"/api-reference/orders/get-order-statistics-v2"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml get /api/v2/orders/{id}","href":"/api-reference/orders/get-order"},{"title":"Append Metadata order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/append_metadata","href":"/api-reference/orders/append-metadata-order"},{"title":"Archive order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/archive","href":"/api-reference/orders/archive-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/cancel","href":"/api-reference/orders/cancel-order"},{"title":"Charge order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml post /api/v2/orders/{id}/charge","href":"/api-reference/orders/charge-order"},{"title":"Remove Metadata order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/remove_metadata","href":"/api-reference/orders/remove-metadata-order"},{"title":"List transaction logs","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml get /api/v2/orders/{id}/transaction_logs","href":"/api-reference/orders/list-transaction-logs"},{"title":"Retry transaction log","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml get /api/v2/orders/{id}/transaction_logs/{transaction_log_id}/retry","href":"/api-reference/orders/retry-transaction-log"},{"title":"Unarchive order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/unarchive","href":"/api-reference/orders/unarchive-order"},{"title":"Update External Id order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/update_external_id","href":"/api-reference/orders/update-external-id-order"},{"title":"Update Shipping Address order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/update_shipping_address","href":"/api-reference/orders/update-shipping-address-order"},{"title":"Update Sponsor order","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2.yaml patch /api/v2/orders/{id}/update_sponsor","href":"/api-reference/orders/update-sponsor-order"},{"group":"Legacy (v0)","pages":[{"title":"Export an order as PDF","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/orders/export_pdf","href":"/api-reference/company-v0/company/export-an-order-as-pdf"},{"title":"Find an order by external ID","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/orders/find_by_external_id","href":"/api-reference/company-v0/company/find-an-order-by-external-id"},{"title":"Get orders","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/orders/{id}","href":"/api-reference/company-v0/company/get-orders"},{"title":"Update orders","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/orders/{id}","href":"/api-reference/company-v0/company/update-orders"},{"title":"Update orders (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/orders/{id}","href":"/api-reference/company-v0/company/update-orders-put"},{"title":"List transaction logs","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/transaction_logs","href":"/api-reference/company-v0/company/list-transaction-logs"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/orders","href":"/api-reference/company-v0/orders/create-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/orders/{id}","href":"/api-reference/company-v0/orders/update-an-order"},{"title":"Update an order (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/orders/{id}","href":"/api-reference/company-v0/orders/update-an-order-put"},{"title":"Get an order's fraud check details","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/orders/{id}/fraud_check_details","href":"/api-reference/company-v0/orders/get-an-orders-fraud-check-details"},{"title":"Review an order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/orders/{id}/review_order","href":"/api-reference/company-v0/orders/review-an-order"},{"title":"Transfer an order to a different customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/orders/{id}/transfer_customer","href":"/api-reference/company-v0/orders/transfer-an-order-to-a-different-customer"},{"title":"Update Order Warehouse","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/orders/{id}/update_warehouse","href":"/api-reference/company-v0/orders/update-order-warehouse"}]}]},{"group":"Promo codes","pages":[{"title":"List promo codes (discounts)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/discounts","href":"/api-reference/discounts/list-promo-codes-discounts"},{"title":"Create a promo code (discount)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/discounts","href":"/api-reference/discounts/create-a-promo-code-discount"},{"title":"Delete several promo codes (discounts)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/discounts/bulk_delete","href":"/api-reference/discounts/delete-several-promo-codes-discounts"},{"title":"Get a promo code (discount)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/discounts/{id}","href":"/api-reference/discounts/get-a-promo-code-discount"},{"title":"Update a promo code (discount)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/discounts/{id}","href":"/api-reference/discounts/update-a-promo-code-discount"},{"title":"Delete a promo code (discount)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/discounts/{id}","href":"/api-reference/discounts/delete-a-promo-code-discount"},{"title":"Copy a promo code (discount)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/discounts/{id}/clone","href":"/api-reference/discounts/copy-a-promo-code-discount"}]},{"group":"Order fulfillment","pages":[{"title":"List order fulfillments","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/order_fulfillments","href":"/api-reference/company-v0/order-fulfillments/list-order-fulfillments"},{"title":"Create order fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/order_fulfillments","href":"/api-reference/company-v0/order-fulfillments/create-order-fulfillment"},{"title":"Show order fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/order_fulfillments/{id}","href":"/api-reference/company-v0/order-fulfillments/show-order-fulfillment"},{"title":"Update order fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/order_fulfillments/{id}","href":"/api-reference/company-v0/order-fulfillments/update-order-fulfillment"},{"title":"Update order fulfillment (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/order_fulfillments/{id}","href":"/api-reference/company-v0/order-fulfillments/update-order-fulfillment-patch"},{"title":"Delete order fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/order_fulfillments/{id}","href":"/api-reference/company-v0/order-fulfillments/delete-order-fulfillment"},{"title":"List tracking informations","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/tracking_informations","href":"/api-reference/company-v0/tracking-informations/list-tracking-informations"},{"title":"Create tracking information","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/tracking_informations","href":"/api-reference/company-v0/tracking-informations/create-tracking-information"},{"title":"Show tracking information","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/tracking_informations/{id}","href":"/api-reference/company-v0/tracking-informations/show-tracking-information"},{"title":"Update tracking information","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/tracking_informations/{id}","href":"/api-reference/company-v0/tracking-informations/update-tracking-information"},{"title":"Delete tracking information","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/tracking_informations/{id}","href":"/api-reference/company-v0/tracking-informations/delete-tracking-information"}]},{"group":"Refunds","pages":[{"title":"Get refund detail (including order_item_refunds)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/refunds/{id}","href":"/api-reference/company-v0/company/get-refund-detail-including-order_item_refunds"},{"title":"Create refund with restock_all_items accounting for existing partial refunds","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/refunds","href":"/api-reference/company-v0/refunds/create-refund-with-restock_all_items-accounting-for-existing-partial-refunds"},{"title":"Create refund for items","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/refunds/items","href":"/api-reference/company-v0/refunds/create-refund-for-items"}]},{"group":"Subscriptions","pages":[{"title":"List company subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/subscriptions","href":"/api-reference/subscriptions/list-company-subscriptions"},{"title":"Export Csv export csv","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/subscriptions/export_csv","href":"/api-reference/subscriptions/export-csv-export-csv"},{"group":"Legacy (v0)","pages":[{"title":"Create a PayPal order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/subscriptions/create_paypal_order","href":"/api-reference/company-v0/company/create-a-paypal-order"},{"title":"List subscription bundles","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscription_bundles","href":"/api-reference/company-v0/subscription-bundles/list-subscription-bundles"},{"title":"Bundle subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscription_bundles/bundle","href":"/api-reference/company-v0/subscription-bundles/bundle-subscriptions"},{"title":"Unbundle subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscription_bundles/unbundle","href":"/api-reference/company-v0/subscription-bundles/unbundle-subscriptions"},{"title":"List of subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions","href":"/api-reference/company-v0/subscriptions/list-of-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions","href":"/api-reference/company-v0/subscriptions/create-a-subscription"},{"title":"Bulk cancel subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/bulk_cancel","href":"/api-reference/company-v0/subscriptions/bulk-cancel-subscriptions"},{"title":"Bulk retry subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/bulk_retry","href":"/api-reference/company-v0/subscriptions/bulk-retry-subscriptions"},{"title":"Schedule retries for a chosen time","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/scheduled_retries","href":"/api-reference/company-v0/subscriptions/schedule-retries-for-a-chosen-time"},{"title":"Email customers to update their payment method","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/payment_update_emails","href":"/api-reference/company-v0/subscriptions/email-customers-to-update-their-payment-method"},{"title":"Email customers whose charge failed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/payment_failed_emails","href":"/api-reference/company-v0/subscriptions/email-customers-whose-charge-failed"},{"title":"Send invoice email","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/send_invoice_email","href":"/api-reference/company-v0/subscriptions/send-invoice-email"},{"title":"Show a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}","href":"/api-reference/company-v0/subscriptions/show-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/subscriptions/{token}","href":"/api-reference/company-v0/subscriptions/update-a-subscription"},{"title":"Update a subscription (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/subscriptions/{token}","href":"/api-reference/company-v0/subscriptions/update-a-subscription-patch"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/cancel","href":"/api-reference/company-v0/subscriptions/cancel-a-subscription"},{"title":"List subscription discount history","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/discounts","href":"/api-reference/company-v0/subscriptions/list-subscription-discount-history"},{"title":"Show the SMS consent of a customer's phone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/sms_consent","href":"/api-reference/company-v0/subscriptions/show-the-sms-consent-of-a-customers-phone"},{"title":"Opt a customer's phone out of SMS","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/sms_consent/opt_out","href":"/api-reference/company-v0/subscriptions/opt-a-customers-phone-out-of-sms"},{"title":"List a customer's autoship profiles","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/profiles","href":"/api-reference/company-v0/subscriptions/list-a-customers-autoship-profiles"},{"title":"Get the autoship profile of a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/profile","href":"/api-reference/company-v0/subscriptions/get-the-autoship-profile-of-a-subscription"},{"title":"Reschedule an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/reschedule","href":"/api-reference/company-v0/subscriptions/reschedule-an-autoship-profile"},{"title":"Change an autoship profile's address","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/change-address","href":"/api-reference/company-v0/subscriptions/change-an-autoship-profiles-address"},{"title":"Change an autoship profile's payment method","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/change-payment-method","href":"/api-reference/company-v0/subscriptions/change-an-autoship-profiles-payment-method"},{"title":"Change an autoship profile's frequency","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/change-frequency","href":"/api-reference/company-v0/subscriptions/change-an-autoship-profiles-frequency"},{"title":"Skip an autoship profile's next shipment","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/skip","href":"/api-reference/company-v0/subscriptions/skip-an-autoship-profiles-next-shipment"},{"title":"Skip one item of an autoship profile once","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/skip-item","href":"/api-reference/company-v0/subscriptions/skip-one-item-of-an-autoship-profile-once"},{"title":"Pause an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/pause","href":"/api-reference/company-v0/subscriptions/pause-an-autoship-profile"},{"title":"Resume an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/resume","href":"/api-reference/company-v0/subscriptions/resume-an-autoship-profile"},{"title":"Preview an item for an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/items/preview","href":"/api-reference/company-v0/subscriptions/preview-an-item-for-an-autoship-profile"},{"title":"Add an item to an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/items","href":"/api-reference/company-v0/subscriptions/add-an-item-to-an-autoship-profile"},{"title":"List the milestone items of a subscription's coming orders","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/milestone_items","href":"/api-reference/company-v0/subscriptions/list-the-milestone-items-of-a-subscriptions-coming-orders"},{"title":"Add a one-time item to a subscription's next order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/milestone_items","href":"/api-reference/company-v0/subscriptions/add-a-one-time-item-to-a-subscriptions-next-order"},{"title":"Remove a one-time item from a subscription's next order","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/subscriptions/{token}/milestone_items/{id}","href":"/api-reference/company-v0/subscriptions/remove-a-one-time-item-from-a-subscriptions-next-order"},{"title":"Show the SMS consent of a subscription's reminder phone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/sms_consent","href":"/api-reference/company-v0/subscriptions/show-the-sms-consent-of-a-subscriptions-reminder-phone"},{"title":"Opt a subscription's reminder phone out of SMS","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/sms_consent/opt_out","href":"/api-reference/company-v0/subscriptions/opt-a-subscriptions-reminder-phone-out-of-sms"},{"title":"Show orders created from the subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/orders","href":"/api-reference/company-v0/subscriptions/show-orders-created-from-the-subscription"},{"title":"Pause a subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/pause","href":"/api-reference/company-v0/subscriptions/pause-a-subscription"},{"title":"Reactivate a cancelled subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/reactivate","href":"/api-reference/company-v0/subscriptions/reactivate-a-cancelled-subscription"},{"title":"Resume subscription billing","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/resume","href":"/api-reference/company-v0/subscriptions/resume-subscription-billing"},{"title":"Preview a failed-cycle waiver","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscriptions/{token}/failed-cycle-waiver","href":"/api-reference/company-v0/subscriptions/preview-a-failed-cycle-waiver"},{"title":"Skip the exhausted failed cycle","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/failed-cycle-waiver","href":"/api-reference/company-v0/subscriptions/skip-the-exhausted-failed-cycle"},{"title":"Retry billing on a past-due subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/retry","href":"/api-reference/company-v0/subscriptions/retry-billing-on-a-past-due-subscription"},{"title":"Reprocess a past-due subscription","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/reprocess","href":"/api-reference/company-v0/subscriptions/reprocess-a-past-due-subscription"},{"title":"Skip next billing","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/skip_next_billing","href":"/api-reference/company-v0/subscriptions/skip-next-billing"},{"title":"Schedule next processing","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/schedule","href":"/api-reference/company-v0/subscriptions/schedule-next-processing"},{"title":"Undo a pending skip","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscriptions/{token}/undo_skip","href":"/api-reference/company-v0/subscriptions/undo-a-pending-skip"}]}]},{"group":"Inventory","pages":[{"title":"List inventory levels","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/inventory_levels","href":"/api-reference/company-v0/inventory-levels/list-inventory-levels"},{"title":"Adjust inventory level","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/inventory_levels/adjust","href":"/api-reference/company-v0/inventory-levels/adjust-inventory-level"},{"title":"Delete multiple inventory levels","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/inventory_levels/bulk_delete","href":"/api-reference/company-v0/inventory-levels/delete-multiple-inventory-levels"},{"title":"Update multiple inventory levels","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/inventory_levels/bulk_update","href":"/api-reference/company-v0/inventory-levels/update-multiple-inventory-levels"},{"title":"Export inventory level csv","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/inventory_levels/export_csv","href":"/api-reference/company-v0/inventory-levels/export-inventory-level-csv"},{"title":"Import inventory level with csv url or with a csv file","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/inventory_levels/import_csv","href":"/api-reference/company-v0/inventory-levels/import-inventory-level-with-csv-url-or-with-a-csv-file"},{"title":"Generate a signed URL to upload csv for bulk importing inventory levels","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/inventory_levels/presigned_csv_url","href":"/api-reference/company-v0/inventory-levels/generate-a-signed-url-to-upload-csv-for-bulk-importing-inventory-levels"},{"title":"Set Inventory Level","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/inventory_levels/set","href":"/api-reference/company-v0/inventory-levels/set-inventory-level"},{"title":"Delete inventory level","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/inventory_levels/{id}","href":"/api-reference/company-v0/inventory-levels/delete-inventory-level"}]},{"group":"Shipping methods","pages":[{"title":"List shipping methods","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/shipping_methods","href":"/api-reference/shipping-methods/list-shipping-methods"},{"title":"Create a shipping method","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/shipping_methods","href":"/api-reference/shipping-methods/create-a-shipping-method"},{"title":"Get shipping methods","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/shipping_methods/{id}","href":"/api-reference/shipping-methods/get-shipping-methods"},{"title":"Update a shipping method","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/shipping_methods/{id}","href":"/api-reference/shipping-methods/update-a-shipping-method"},{"title":"Replace a shipping method","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/shipping_methods/{id}","href":"/api-reference/shipping-methods/replace-a-shipping-method"},{"title":"Delete shipping methods","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/shipping_methods/{id}","href":"/api-reference/shipping-methods/delete-shipping-methods"},{"title":"List shipping method rates","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/shipping_methods/{shipping_method_id}/shipping_method_rates","href":"/api-reference/shipping-methods/list-shipping-method-rates"},{"title":"Create a shipping method rate","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/shipping_methods/{shipping_method_id}/shipping_method_rates","href":"/api-reference/shipping-methods/create-a-shipping-method-rate"},{"title":"Update a shipping method rate","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/shipping_methods/{shipping_method_id}/shipping_method_rates/{id}","href":"/api-reference/shipping-methods/update-a-shipping-method-rate"},{"title":"Replace a shipping method rate","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/shipping_methods/{shipping_method_id}/shipping_method_rates/{id}","href":"/api-reference/shipping-methods/replace-a-shipping-method-rate"},{"title":"Delete shipping method rates","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/shipping_methods/{shipping_method_id}/shipping_method_rates/{id}","href":"/api-reference/shipping-methods/delete-shipping-method-rates"}]},{"group":"Options","pages":[{"title":"List company product options","deprecated":null,"version":null,"openapi":"/api-reference/storefront-v2026-04.yaml get /api/v202604/company/options","href":"/api-reference/options/list-company-product-options"}]}]},{"group":"Checkout","pages":[{"group":"Carts","pages":[{"title":"Create a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts","href":"/api-reference/carts/create-a-cart"},{"title":"Flag a cart as enrollment eligible","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/carts/{cart_token}/enrollment","href":"/api-reference/carts/flag-a-cart-as-enrollment-eligible"},{"title":"Show a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}","href":"/api-reference/carts/show-a-cart"},{"title":"Update cart attributes","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/carts/{cart_token}","href":"/api-reference/carts/update-cart-attributes"},{"title":"Update cart attributes (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}","href":"/api-reference/carts/update-cart-attributes-put"},{"title":"Set cart address","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/address","href":"/api-reference/carts/set-cart-address"},{"title":"Complete checkout","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/complete","href":"/api-reference/carts/complete-checkout"},{"title":"Change cart country","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/country","href":"/api-reference/carts/change-cart-country"},{"title":"Cancel the open redirect payment","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/payment","href":"/api-reference/carts/cancel-the-open-redirect-payment"},{"title":"Return to the open redirect payment","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}/payment/resume","href":"/api-reference/carts/return-to-the-open-redirect-payment"},{"title":"Update cart language","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/carts/{cart_token}/language","href":"/api-reference/carts/update-cart-language"},{"title":"Update cart metadata","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/carts/{cart_token}/metadata","href":"/api-reference/carts/update-cart-metadata"},{"title":"Recalculate cart totals","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/recalculate","href":"/api-reference/carts/recalculate-cart-totals"},{"title":"Select shipping method","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}/shipping","href":"/api-reference/carts/select-shipping-method"},{"title":"Sync customer data to cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/sync","href":"/api-reference/carts/sync-customer-data-to-cart"},{"title":"Set volume rep","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/volume_rep","href":"/api-reference/carts/set-volume-rep"}]},{"group":"Cart items","pages":[{"title":"Add items to cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/items","href":"/api-reference/cart-items/add-items-to-cart"},{"title":"Update a cart item","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/carts/{cart_token}/items/{id}","href":"/api-reference/cart-items/update-a-cart-item"},{"title":"Update a cart item (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}/items/{id}","href":"/api-reference/cart-items/update-a-cart-item-put"},{"title":"Remove a cart item","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/items/{id}","href":"/api-reference/cart-items/remove-a-cart-item"},{"title":"Subscribe a cart item","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/items/{item_id}/subscription","href":"/api-reference/cart-items/subscribe-a-cart-item"},{"title":"Unsubscribe a cart item","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/items/{item_id}/subscription","href":"/api-reference/cart-items/unsubscribe-a-cart-item"}]},{"group":"Discounts","pages":[{"title":"Apply a promo code to a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/discount","href":"/api-reference/cart-discount/apply-a-promo-code-to-a-cart"},{"title":"Remove a promo code from a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/discount","href":"/api-reference/cart-discount/remove-a-promo-code-from-a-cart"},{"title":"Apply manual discount (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/discount/manual","href":"/api-reference/cart-discount/apply-manual-discount-admin-only"},{"title":"List the promo codes and discounts on a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}/discounts","href":"/api-reference/cart-discount/list-the-promo-codes-and-discounts-on-a-cart"}]},{"group":"Points","pages":[{"title":"Apply points","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/points","href":"/api-reference/cart-points/apply-points"},{"title":"Remove points","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/points","href":"/api-reference/cart-points/remove-points"}]},{"group":"Cart sign-in","pages":[{"title":"Logout from cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/auth","href":"/api-reference/cart-auth/logout-from-cart"},{"title":"Issue a checkout URL that carries the shopper's login","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/handoff","href":"/api-reference/cart-auth/issue-a-checkout-url-that-carries-the-shoppers-login"},{"title":"Send magic link","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/auth/magic_link","href":"/api-reference/cart-auth/send-magic-link"},{"title":"List cart countries and languages","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}/auth/me","href":"/api-reference/cart-auth/list-cart-countries-and-languages"},{"title":"Verify magic link","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/auth/verify","href":"/api-reference/cart-auth/verify-magic-link"}]},{"group":"Cart payments","pages":[{"title":"Set the cart payment method","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml put /api/payments/v2026-04/carts/{cart_token}/payment_method","href":"/api-reference/payments/set-the-cart-payment-method"},{"title":"Provision VGS vault credentials","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/tokenize","href":"/api-reference/payments/provision-vgs-vault-credentials"},{"title":"Open the bank account (ACH) session","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/ach-session","href":"/api-reference/payments/open-the-bank-account-ach-session"},{"title":"Initialize 3DS verification","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/verify","href":"/api-reference/payments/initialize-3ds-verification"},{"title":"Get PayPal client SDK token","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml get /api/payments/v2026-04/carts/{cart_token}/paypal/token","href":"/api-reference/paypal/get-paypal-client-sdk-token"},{"title":"Create a PayPal order","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/paypal/orders","href":"/api-reference/paypal/create-a-paypal-order"},{"title":"Authorize a PayPal order","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/paypal/authorize","href":"/api-reference/paypal/authorize-a-paypal-order"},{"title":"Apply a PayPal shipping address change","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml patch /api/payments/v2026-04/carts/{cart_token}/paypal/shipping","href":"/api-reference/paypal/apply-a-paypal-shipping-address-change"},{"title":"Get Braintree client token","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml get /api/payments/v2026-04/carts/{cart_token}/braintree/token","href":"/api-reference/braintree/get-braintree-client-token"},{"title":"Authorize a Braintree transaction","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/braintree/pay","href":"/api-reference/braintree/authorize-a-braintree-transaction"},{"title":"Create a Klarna payment session","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/klarna/sessions","href":"/api-reference/klarna/create-a-klarna-payment-session"},{"title":"Update a Klarna payment session","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml patch /api/payments/v2026-04/carts/{cart_token}/klarna/sessions","href":"/api-reference/klarna/update-a-klarna-payment-session"},{"title":"Validate an Apple Pay merchant session","deprecated":null,"version":null,"openapi":"/api-reference/payments-v2026-04.yaml post /api/payments/v2026-04/carts/{cart_token}/apple_pay/validate","href":"/api-reference/apple-pay/validate-an-apple-pay-merchant-session"}]},{"group":"Enrollments","pages":[{"title":"Show enrollment","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/enrollments/{token}","href":"/api-reference/enrollments/show-enrollment"},{"title":"Submit enrollment field answer","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/enrollments/{token}/fields/{field_id}","href":"/api-reference/enrollments/submit-enrollment-field-answer"},{"title":"Update enrollment field answer","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/enrollments/{token}/fields/{field_id}","href":"/api-reference/enrollments/update-enrollment-field-answer"},{"title":"Upload file for enrollment field","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/enrollments/{token}/fields/{field_id}/upload","href":"/api-reference/enrollments/upload-file-for-enrollment-field"}]},{"group":"Order lookup","pages":[{"title":"Show order","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/orders/{token}","href":"/api-reference/orders/show-order"}]},{"group":"Products","pages":[{"title":"Query product","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/products/{id}","href":"/api-reference/products/query-product"}]},{"group":"Store","pages":[{"title":"Get address fields for country","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/address_fields/{country_code}","href":"/api-reference/store/get-address-fields-for-country"},{"title":"Get the checkout contract for a country","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/contract/{country_code}","href":"/api-reference/store/get-the-checkout-contract-for-a-country"},{"title":"Get agreement content","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/agreements/{id}","href":"/api-reference/store/get-agreement-content"},{"title":"Apple Pay domain verification","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/apple_pay_domain/{hostname}","href":"/api-reference/store/apple-pay-domain-verification"},{"title":"Get checkout config","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/config","href":"/api-reference/store/get-checkout-config"},{"title":"List available countries","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/countries","href":"/api-reference/store/list-available-countries"},{"title":"List drop zones","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/drop_zones","href":"/api-reference/store/list-drop-zones"},{"title":"List available languages","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/store/languages","href":"/api-reference/store/list-available-languages"}]},{"group":"Customer account","pages":[{"title":"Get customer profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me","href":"/api-reference/customers/get-customer-profile"},{"title":"Update customer profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/customers/me","href":"/api-reference/customers/update-customer-profile"},{"title":"List customer companies","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/companies","href":"/api-reference/customers/list-customer-companies"}]},{"group":"Customer addresses","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/addresses","href":"/api-reference/customer-addresses/list-customer-addresses"},{"title":"Create customer address","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/customers/me/addresses","href":"/api-reference/customer-addresses/create-customer-address"},{"title":"Update customer address","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/customers/me/addresses/{id}","href":"/api-reference/customer-addresses/update-customer-address"},{"title":"Update customer address (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/customers/me/addresses/{id}","href":"/api-reference/customer-addresses/update-customer-address-put"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/customers/me/addresses/{id}","href":"/api-reference/customer-addresses/delete-customer-address"},{"title":"Apply address to subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/customers/me/addresses/{id}/apply_to_subscriptions","href":"/api-reference/customer-addresses/apply-address-to-subscriptions"}]},{"group":"Customer orders","pages":[{"title":"List customer orders","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/orders","href":"/api-reference/customer-orders/list-customer-orders"}]},{"group":"Customer payment methods","pages":[{"title":"List customer payment methods","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/payment_methods","href":"/api-reference/customer-payment-methods/list-customer-payment-methods"},{"title":"Create customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/customers/me/payment_methods","href":"/api-reference/customer-payment-methods/create-customer-payment-method"},{"title":"Last used alternate payment details","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/payment_methods/customer_details","href":"/api-reference/customer-payment-methods/last-used-alternate-payment-details"},{"title":"Tokenize payment credentials","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/customers/me/payment_methods/tokenize","href":"/api-reference/customer-payment-methods/tokenize-payment-credentials"},{"title":"Update customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/customers/me/payment_methods/{id}","href":"/api-reference/customer-payment-methods/update-customer-payment-method"},{"title":"Update customer payment method (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/customers/me/payment_methods/{id}","href":"/api-reference/customer-payment-methods/update-customer-payment-method-put"},{"title":"Delete customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/customers/me/payment_methods/{id}","href":"/api-reference/customer-payment-methods/delete-customer-payment-method"}]},{"group":"Customer points","pages":[{"title":"List customer points ledger","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/customers/me/points","href":"/api-reference/customer-points/list-customer-points-ledger"}]},{"group":"Subscriptions","pages":[{"title":"Show a win-back offer","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/win-back-offer","href":"/api-reference/subscriptions/show-a-win-back-offer"},{"title":"Take a win-back offer","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/win-back-offer/accept","href":"/api-reference/subscriptions/take-a-win-back-offer"},{"title":"Stop marketing email from a win-back email","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/win-back-offer/unsubscribe","href":"/api-reference/subscriptions/stop-marketing-email-from-a-win-back-email"},{"title":"One-click unsubscribe from a win-back email","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/win-back-offer/unsubscribe/one-click","href":"/api-reference/subscriptions/one-click-unsubscribe-from-a-win-back-email"},{"title":"List subscription bundles","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscription_bundles","href":"/api-reference/subscription-bundles/list-subscription-bundles"},{"title":"Create subscription bundle","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription_bundles","href":"/api-reference/subscription-bundles/create-subscription-bundle"},{"title":"Get the sign-in facts for a subscription link","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions/{token}/sign-in","href":"/api-reference/subscriptions/get-the-sign-in-facts-for-a-subscription-link"},{"title":"Get the sign-in facts for a shop","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/sign-in-company","href":"/api-reference/subscriptions/get-the-sign-in-facts-for-a-shop"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions","href":"/api-reference/subscriptions/create-a-subscription"},{"title":"Show subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions/{token}","href":"/api-reference/subscriptions/show-subscription"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml patch /api/checkout/v2026-04/subscriptions/{token}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Update subscription (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/subscriptions/{token}","href":"/api-reference/subscriptions/update-subscription-put"},{"title":"List subscription discounts","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions/{token}/discounts","href":"/api-reference/subscriptions/list-subscription-discounts"},{"title":"Attach subscription discount","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/discounts","href":"/api-reference/subscriptions/attach-subscription-discount"},{"title":"Remove subscription discount","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/subscriptions/{token}/discounts/{id}","href":"/api-reference/subscriptions/remove-subscription-discount"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Start a cancel flow session","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{subscription_token}/cancellation-sessions","href":"/api-reference/subscriptions/start-a-cancel-flow-session"},{"title":"Give the reason for cancelling","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{subscription_token}/cancellation-sessions/{id}/reason","href":"/api-reference/subscriptions/give-the-reason-for-cancelling"},{"title":"Accept a save offer","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{subscription_token}/cancellation-sessions/{id}/accept","href":"/api-reference/subscriptions/accept-a-save-offer"},{"title":"Cancel through the session","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{subscription_token}/cancellation-sessions/{id}/cancel","href":"/api-reference/subscriptions/cancel-through-the-session"},{"title":"Pause subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/pause","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Reactivate subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/reactivate","href":"/api-reference/subscriptions/reactivate-subscription"},{"title":"Resume subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/resume","href":"/api-reference/subscriptions/resume-subscription"},{"title":"Preview a failed-cycle waiver","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions/{token}/failed-cycle-waiver","href":"/api-reference/subscriptions/preview-a-failed-cycle-waiver"},{"title":"Skip the exhausted failed cycle","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/failed-cycle-waiver","href":"/api-reference/subscriptions/skip-the-exhausted-failed-cycle"},{"title":"Retry billing on a past-due subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/retry","href":"/api-reference/subscriptions/retry-billing-on-a-past-due-subscription"},{"title":"Skip subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/skip","href":"/api-reference/subscriptions/skip-subscription"},{"title":"Undo_skip subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/undo_skip","href":"/api-reference/subscriptions/undo_skip-subscription"},{"title":"Get a subscription's texts choice","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/subscriptions/{token}/sms-consent","href":"/api-reference/subscription-sms-consent/get-a-subscriptions-texts-choice"},{"title":"Change a subscription's texts choice","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/subscriptions/{token}/sms-consent","href":"/api-reference/subscription-sms-consent/change-a-subscriptions-texts-choice"},{"title":"Decline a paid milestone item of the next order","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/milestone-declines","href":"/api-reference/subscriptions/decline-a-paid-milestone-item-of-the-next-order"}]},{"group":"Cart sms consent","pages":[{"title":"Get the subscription texts disclosure","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}/sms-consent","href":"/api-reference/cart-sms-consent/get-the-subscription-texts-disclosure"},{"title":"Record the subscription texts choice","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}/sms-consent","href":"/api-reference/cart-sms-consent/record-the-subscription-texts-choice"}]},{"group":"Subscription profiles","pages":[{"title":"Reschedule an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/reschedule","href":"/api-reference/subscription-profiles/reschedule-an-autoship-profile"},{"title":"Change an autoship profile's address","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/change-address","href":"/api-reference/subscription-profiles/change-an-autoship-profiles-address"},{"title":"Change an autoship profile's payment method","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/change-payment-method","href":"/api-reference/subscription-profiles/change-an-autoship-profiles-payment-method"},{"title":"Change an autoship profile's frequency","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/change-frequency","href":"/api-reference/subscription-profiles/change-an-autoship-profiles-frequency"},{"title":"Skip an autoship profile's next shipment","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/skip","href":"/api-reference/subscription-profiles/skip-an-autoship-profiles-next-shipment"},{"title":"Skip one item of an autoship profile once","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/skip-item","href":"/api-reference/subscription-profiles/skip-one-item-of-an-autoship-profile-once"},{"title":"Pause an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/pause","href":"/api-reference/subscription-profiles/pause-an-autoship-profile"},{"title":"Resume an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/resume","href":"/api-reference/subscription-profiles/resume-an-autoship-profile"},{"title":"List autoship profiles for a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/carts/{cart_token}/autoship-profiles","href":"/api-reference/subscription-profiles/list-autoship-profiles-for-a-cart"},{"title":"Choose an autoship profile for a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}/autoship-profile","href":"/api-reference/subscription-profiles/choose-an-autoship-profile-for-a-cart"},{"title":"Clear the autoship profile choice for a cart","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml delete /api/checkout/v2026-04/carts/{cart_token}/autoship-profile","href":"/api-reference/subscription-profiles/clear-the-autoship-profile-choice-for-a-cart"},{"title":"List the items a customer can add to an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/items/eligible","href":"/api-reference/subscription-profiles/list-the-items-a-customer-can-add-to-an-autoship-profile"},{"title":"Preview an item for an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/items/preview","href":"/api-reference/subscription-profiles/preview-an-item-for-an-autoship-profile"},{"title":"Add an item to an autoship profile","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/items","href":"/api-reference/subscription-profiles/add-an-item-to-an-autoship-profile"}]},{"group":"Subscription manage link","pages":[{"title":"List manage link subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/manage-link/subscriptions","href":"/api-reference/subscription-manage-link/list-manage-link-subscriptions"},{"title":"Decline a paid milestone item of the next order","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/milestone-declines","href":"/api-reference/subscription-manage-link/decline-a-paid-milestone-item-of-the-next-order"},{"title":"Skip a subscription's next order","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/skip","href":"/api-reference/subscription-manage-link/skip-a-subscriptions-next-order"},{"title":"Undo a skipped order","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/undo-skip","href":"/api-reference/subscription-manage-link/undo-a-skipped-order"},{"title":"Pause a subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/pause","href":"/api-reference/subscription-manage-link/pause-a-subscription"},{"title":"Resume a subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/resume","href":"/api-reference/subscription-manage-link/resume-a-subscription"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/manage-link/subscriptions/{token}/cancel","href":"/api-reference/subscription-manage-link/cancel-a-subscription"}]},{"group":"Braintree","pages":[{"title":"Save a Braintree PayPal account without a charge","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/braintree/vault-payment-method","href":"/api-reference/braintree/save-a-braintree-paypal-account-without-a-charge"}]}]},{"group":"Member API","pages":[{"title":"Member APIs","sidebarTitle":"Member APIs overview","href":"/api/member-apis"},{"title":"Genealogy CLI","sidebarTitle":"Genealogy CLI","href":"/api/genealogy-cli"},{"group":"Account","pages":[{"title":"List the signed-in member's social accounts","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/socials","href":"/api-reference/socials/list-the-signed-in-members-social-accounts"},{"title":"Upsert one social account","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml put /api/member/v2026-10/socials/{platform}","href":"/api-reference/socials/upsert-one-social-account"},{"title":"Remove one social account","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/socials/{platform}","href":"/api-reference/socials/remove-one-social-account"},{"title":"Show the signed-in member's public profile","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/profile","href":"/api-reference/profile/show-the-signed-in-members-public-profile"},{"title":"Update the signed-in member's public profile","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/profile","href":"/api-reference/profile/update-the-signed-in-members-public-profile"},{"title":"Show the signed-in member","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/me","href":"/api-reference/me/show-the-signed-in-member"},{"title":"Update the signed-in member","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/me","href":"/api-reference/me/update-the-signed-in-member"},{"title":"List the company's languages","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/languages","href":"/api-reference/me/list-the-companys-languages"},{"title":"List the user's memberships","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/companies","href":"/api-reference/companies/list-the-users-memberships"},{"title":"Show the member's points balance","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/points","href":"/api-reference/points/show-the-members-points-balance"},{"title":"List the member's points ledger","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/points/ledger","href":"/api-reference/points/list-the-members-points-ledger"},{"title":"List the member's saved addresses","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/addresses","href":"/api-reference/addresses/list-the-members-saved-addresses"},{"title":"Save an address","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/addresses","href":"/api-reference/addresses/save-an-address"},{"title":"Show a saved address","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/addresses/{id}","href":"/api-reference/addresses/show-a-saved-address"},{"title":"Change a saved address","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/addresses/{id}","href":"/api-reference/addresses/change-a-saved-address"},{"title":"Remove a saved address","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/addresses/{id}","href":"/api-reference/addresses/remove-a-saved-address"},{"title":"Make a saved address the default","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/addresses/{id}/default","href":"/api-reference/addresses/make-a-saved-address-the-default"}]},{"group":"Settings","pages":[{"title":"List applicable agreements","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/agreements","href":"/api-reference/agreements/list-applicable-agreements"},{"title":"Show an agreement","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/agreements/{id}","href":"/api-reference/agreements/show-an-agreement"},{"title":"Accept an agreement","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/agreements/{id}/accept","href":"/api-reference/agreements/accept-an-agreement"},{"title":"Show the company's release flags","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/features","href":"/api-reference/features/show-the-companys-release-flags"},{"title":"List the member's site updates","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/notifications","href":"/api-reference/notifications/list-the-members-site-updates"},{"title":"Count unread site updates","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/notifications/unread","href":"/api-reference/notifications/count-unread-site-updates"},{"title":"Mark every site update read","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/notifications/read-all","href":"/api-reference/notifications/mark-every-site-update-read"},{"title":"Mark a site's updates read","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/notifications/sites/{site_id}/read","href":"/api-reference/notifications/mark-a-sites-updates-read"},{"title":"Mark one site update read","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/notifications/{id}/read","href":"/api-reference/notifications/mark-one-site-update-read"},{"title":"Show notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/notifications/preferences","href":"/api-reference/notification-preferences/show-notification-preferences"},{"title":"Change notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml patch /api/member/v2026-10/notifications/preferences","href":"/api-reference/notification-preferences/change-notification-preferences"},{"title":"List push devices","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/notifications/devices","href":"/api-reference/notification-devices/list-push-devices"},{"title":"Register a push device","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml post /api/member/v2026-10/notifications/devices","href":"/api-reference/notification-devices/register-a-push-device"},{"title":"Remove a push device","deprecated":null,"version":null,"openapi":"/api-reference/member-settings-v2026-10.yaml delete /api/member/v2026-10/notifications/devices/{id}","href":"/api-reference/notification-devices/remove-a-push-device"}]},{"group":"Payments","pages":[{"title":"Show the member's Pro plan","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml get /api/member/v2026-10/plan","href":"/api-reference/plan/show-the-members-pro-plan"},{"title":"List the Pro plans on offer","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml get /api/member/v2026-10/plan/options","href":"/api-reference/plan/list-the-pro-plans-on-offer"},{"title":"List the member's paid add-ons","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml get /api/member/v2026-10/plan/add-ons","href":"/api-reference/plan/list-the-members-paid-add-ons"},{"title":"List the member's saved payment methods","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml get /api/member/v2026-10/payment-methods","href":"/api-reference/payment-methods/list-the-members-saved-payment-methods"},{"title":"Save a card","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml post /api/member/v2026-10/payment-methods","href":"/api-reference/payment-methods/save-a-card"},{"title":"Change a saved payment method","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml patch /api/member/v2026-10/payment-methods/{id}","href":"/api-reference/payment-methods/change-a-saved-payment-method"},{"title":"Remove a saved payment method","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml delete /api/member/v2026-10/payment-methods/{id}","href":"/api-reference/payment-methods/remove-a-saved-payment-method"},{"title":"Get the card vault setup","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml get /api/member/v2026-10/payment-methods/vault","href":"/api-reference/payment-methods/get-the-card-vault-setup"},{"title":"Confirm a card verification","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml post /api/member/v2026-10/payment-methods/three-ds/confirm","href":"/api-reference/payment-methods/confirm-a-card-verification"},{"title":"Read a card verification","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml post /api/member/v2026-10/payment-methods/three-ds/status","href":"/api-reference/payment-methods/read-a-card-verification"},{"title":"Cancel a card verification","deprecated":null,"version":null,"openapi":"/api-reference/member-payments-v2026-10.yaml post /api/member/v2026-10/payment-methods/three-ds/cancel","href":"/api-reference/payment-methods/cancel-a-card-verification"}]},{"group":"Contacts","pages":[{"title":"List the member's contacts","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts","href":"/api-reference/contacts/list-the-members-contacts"},{"title":"Add a contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts","href":"/api-reference/contacts/add-a-contact"},{"title":"Search the member's contacts","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/search","href":"/api-reference/contacts/search-the-members-contacts"},{"title":"Add contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts/bulk","href":"/api-reference/contacts/add-contacts-in-bulk"},{"title":"Remove contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/contacts/bulk","href":"/api-reference/contacts/remove-contacts-in-bulk"},{"title":"Import contacts from a CSV file","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts/import","href":"/api-reference/contacts/import-contacts-from-a-csv-file"},{"title":"Show a contact import","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/imports/{id}","href":"/api-reference/contacts/show-a-contact-import"},{"title":"Show one contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/{id}","href":"/api-reference/contacts/show-one-contact"},{"title":"Change a contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/contacts/{id}","href":"/api-reference/contacts/change-a-contact"},{"title":"Remove a contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/contacts/{id}","href":"/api-reference/contacts/remove-a-contact"},{"title":"Mark a contact's activity read","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts/{id}/read","href":"/api-reference/contacts/mark-a-contacts-activity-read"},{"title":"List a contact's activities","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/{id}/activities","href":"/api-reference/contacts/list-a-contacts-activities"},{"title":"List a contact's notes","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/{id}/notes","href":"/api-reference/contacts/list-a-contacts-notes"},{"title":"Add a note to a contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts/{id}/notes","href":"/api-reference/contacts/add-a-note-to-a-contact"},{"title":"List a contact's tasks","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts/{id}/tasks","href":"/api-reference/contacts/list-a-contacts-tasks"},{"title":"Add a task about a contact","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/contacts/{id}/tasks","href":"/api-reference/contacts/add-a-task-about-a-contact"}]},{"group":"Groups","pages":[{"title":"List the member's groups","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/groups","href":"/api-reference/groups/list-the-members-groups"},{"title":"Add a group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/groups","href":"/api-reference/groups/add-a-group"},{"title":"Show one group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/groups/{id}","href":"/api-reference/groups/show-one-group"},{"title":"Change a group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/groups/{id}","href":"/api-reference/groups/change-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/groups/{id}","href":"/api-reference/groups/delete-a-group"},{"title":"Add contacts to a group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/groups/{id}/contacts","href":"/api-reference/groups/add-contacts-to-a-group"},{"title":"Remove contacts from a group","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/groups/{id}/contacts","href":"/api-reference/groups/remove-contacts-from-a-group"}]},{"group":"Notes","pages":[{"title":"List the member's notes","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/notes","href":"/api-reference/notes/list-the-members-notes"},{"title":"Add a note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/notes","href":"/api-reference/notes/add-a-note"},{"title":"Show one note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/notes/{id}","href":"/api-reference/notes/show-one-note"},{"title":"Change a note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/notes/{id}","href":"/api-reference/notes/change-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/notes/{id}","href":"/api-reference/notes/delete-a-note"},{"title":"Pin a note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/notes/{id}/pin","href":"/api-reference/notes/pin-a-note"},{"title":"Unpin a note","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/notes/{id}/unpin","href":"/api-reference/notes/unpin-a-note"}]},{"group":"Tasks","pages":[{"title":"List the member's tasks","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/tasks","href":"/api-reference/tasks/list-the-members-tasks"},{"title":"Add a task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/tasks","href":"/api-reference/tasks/add-a-task"},{"title":"Show one task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/tasks/{id}","href":"/api-reference/tasks/show-one-task"},{"title":"Change a task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml patch /api/member/v2026-10/tasks/{id}","href":"/api-reference/tasks/change-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml delete /api/member/v2026-10/tasks/{id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Complete a task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/tasks/{id}/complete","href":"/api-reference/tasks/complete-a-task"},{"title":"Reopen a task","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/tasks/{id}/reopen","href":"/api-reference/tasks/reopen-a-task"}]},{"group":"Activities","pages":[{"title":"List the member's activity feed","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/activities","href":"/api-reference/activities/list-the-members-activity-feed"},{"title":"Show one activity","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/activities/{id}","href":"/api-reference/activities/show-one-activity"},{"title":"Mark activities read","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml post /api/member/v2026-10/activities/read","href":"/api-reference/activities/mark-activities-read"},{"title":"Count unread activities","deprecated":null,"version":null,"openapi":"/api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/activities/unread","href":"/api-reference/activities/count-unread-activities"}]},{"group":"Calendar","pages":[{"title":"List calendar events in a window","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml get /api/member/v2026-10/calendar/events","href":"/api-reference/calendar-events/list-calendar-events-in-a-window"},{"title":"Add a personal calendar event","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml post /api/member/v2026-10/calendar/events","href":"/api-reference/calendar-events/add-a-personal-calendar-event"},{"title":"Show a calendar event","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml get /api/member/v2026-10/calendar/events/{id}","href":"/api-reference/calendar-events/show-a-calendar-event"},{"title":"Change a personal calendar event","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml patch /api/member/v2026-10/calendar/events/{id}","href":"/api-reference/calendar-events/change-a-personal-calendar-event"},{"title":"Delete a personal calendar event","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml delete /api/member/v2026-10/calendar/events/{id}","href":"/api-reference/calendar-events/delete-a-personal-calendar-event"},{"title":"RSVP to a company event","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml post /api/member/v2026-10/calendar/events/{id}/rsvp","href":"/api-reference/calendar-events/rsvp-to-a-company-event"},{"title":"List catch-ups","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml get /api/member/v2026-10/calendar/catch-ups","href":"/api-reference/calendar-catch-ups/list-catch-ups"},{"title":"Dismiss a catch-up","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml post /api/member/v2026-10/calendar/catch-ups/{id}/dismiss","href":"/api-reference/calendar-catch-ups/dismiss-a-catch-up"},{"title":"Complete a catch-up","deprecated":null,"version":null,"openapi":"/api-reference/member-calendar-v2026-10.yaml post /api/member/v2026-10/calendar/catch-ups/{id}/complete","href":"/api-reference/calendar-catch-ups/complete-a-catch-up"}]},{"group":"Orders and carts","pages":[{"title":"List the signed-in member’s orders","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/orders","href":"/api-reference/orders/list-the-signed-in-member’s-orders"},{"title":"Show one accessible order","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/orders/{id}","href":"/api-reference/orders/show-one-accessible-order"},{"title":"List a contact's orders","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/contacts/{id}/orders","href":"/api-reference/orders/list-a-contacts-orders"},{"title":"List the member's carts","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/carts","href":"/api-reference/carts/list-the-members-carts"},{"title":"Create a cart for the signed-in member","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/carts","href":"/api-reference/carts/create-a-cart-for-the-signed-in-member"},{"title":"Show one of the member's carts","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/carts/{token}","href":"/api-reference/carts/show-one-of-the-members-carts"},{"title":"Claim a guest cart","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/carts/{token}/claim","href":"/api-reference/carts/claim-a-guest-cart"}]},{"group":"Subscriptions","pages":[{"title":"List runtime bundle candidates","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/bundle-candidates","href":"/api-reference/subscriptions/list-runtime-bundle-candidates"},{"title":"List a contact's subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/contacts/{id}/subscriptions","href":"/api-reference/subscriptions/list-a-contacts-subscriptions"},{"title":"List the signed-in member’s product subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions","href":"/api-reference/subscriptions/list-the-signed-in-member’s-product-subscriptions"},{"title":"Read the next scheduled subscription summary","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/next","href":"/api-reference/subscriptions/read-the-next-scheduled-subscription-summary"},{"title":"Count the member's subscriptions by status","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/summary","href":"/api-reference/subscriptions/count-the-members-subscriptions-by-status"},{"title":"Align selected product subscriptions atomically","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/bundle","href":"/api-reference/subscriptions/align-selected-product-subscriptions-atomically"},{"title":"Show one of the member’s subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/{id}","href":"/api-reference/subscriptions/show-one-of-the-member’s-subscriptions"},{"title":"Edit an owned product subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml patch /api/member/v2026-10/subscriptions/{id}","href":"/api-reference/subscriptions/edit-an-owned-product-subscription"},{"title":"Pause an owned subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-an-owned-subscription"},{"title":"Resume an owned subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-an-owned-subscription"},{"title":"Skip the next subscription billing cycle","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/skip","href":"/api-reference/subscriptions/skip-the-next-subscription-billing-cycle"},{"title":"Undo a specific subscription billing skip","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/undo","href":"/api-reference/subscriptions/undo-a-specific-subscription-billing-skip"},{"title":"Cancel an owned subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-an-owned-subscription"},{"title":"Reactivate an owned subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/reactivate","href":"/api-reference/subscriptions/reactivate-an-owned-subscription"},{"title":"Queue a subscription payment retry","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/retry","href":"/api-reference/subscriptions/queue-a-subscription-payment-retry"},{"title":"List owned subscription discount history","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/{id}/discounts","href":"/api-reference/subscriptions/list-owned-subscription-discount-history"},{"title":"Attach a subscription discount","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/discounts","href":"/api-reference/subscriptions/attach-a-subscription-discount"},{"title":"Remove a subscription discount attachment","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml delete /api/member/v2026-10/subscriptions/{id}/discounts/{attachment_id}","href":"/api-reference/subscriptions/remove-a-subscription-discount-attachment"},{"title":"Preview a failed-cycle waiver for an owned subscription","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/{id}/failed-cycle-waiver","href":"/api-reference/subscriptions/preview-a-failed-cycle-waiver-for-an-owned-subscription"},{"title":"Accept a failed-cycle waiver","deprecated":null,"version":null,"openapi":"/api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/failed-cycle-waiver","href":"/api-reference/subscriptions/accept-a-failed-cycle-waiver"}]},{"group":"Media","pages":[{"title":"List the member's media","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/media","href":"/api-reference/media/list-the-members-media"},{"title":"Create a medium from an upload","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/media","href":"/api-reference/media/create-a-medium-from-an-upload"},{"title":"Show one of the member's media","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/media/{id}","href":"/api-reference/media/show-one-of-the-members-media"},{"title":"Edit a medium's details","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml patch /api/member/v2026-10/media/{id}","href":"/api-reference/media/edit-a-mediums-details"},{"title":"Delete a medium","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml delete /api/member/v2026-10/media/{id}","href":"/api-reference/media/delete-a-medium"},{"title":"Search the storefront catalogue","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/search","href":"/api-reference/search/search-the-storefront-catalogue"},{"title":"Sign a direct upload","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/media/uploads","href":"/api-reference/media-uploads/sign-a-direct-upload"}]},{"group":"Playlists","pages":[{"title":"List the member's playlists","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/playlists","href":"/api-reference/playlists/list-the-members-playlists"},{"title":"Create a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/playlists","href":"/api-reference/playlists/create-a-playlist"},{"title":"Show one of the member's playlists","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/playlists/{id}","href":"/api-reference/playlists/show-one-of-the-members-playlists"},{"title":"Edit a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml patch /api/member/v2026-10/playlists/{id}","href":"/api-reference/playlists/edit-a-playlist"},{"title":"Delete a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml delete /api/member/v2026-10/playlists/{id}","href":"/api-reference/playlists/delete-a-playlist"},{"title":"List a playlist's items","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/playlists/{id}/items","href":"/api-reference/playlist-items/list-a-playlists-items"},{"title":"Add a medium to a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/playlists/{id}/items","href":"/api-reference/playlist-items/add-a-medium-to-a-playlist"},{"title":"Reorder a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml patch /api/member/v2026-10/playlists/{id}/items/reorder","href":"/api-reference/playlist-items/reorder-a-playlist"},{"title":"Remove an item from a playlist","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml delete /api/member/v2026-10/playlists/{id}/items/{item_id}","href":"/api-reference/playlist-items/remove-an-item-from-a-playlist"}]},{"group":"Shares","pages":[{"title":"Prepare selected photos for sharing","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/photo-share-preparations","href":"/api-reference/shares/prepare-selected-photos-for-sharing"},{"title":"Create or reuse the member's referral shop link","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/referral-shares","href":"/api-reference/shares/create-or-reuse-the-members-referral-shop-link"},{"title":"List the member's shares","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/shares","href":"/api-reference/shares/list-the-members-shares"},{"title":"Create a tracked share","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml post /api/member/v2026-10/shares","href":"/api-reference/shares/create-a-tracked-share"},{"title":"Show a share and its activity","deprecated":null,"version":null,"openapi":"/api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/shares/{id}","href":"/api-reference/shares/show-a-share-and-its-activity"}]},{"group":"Stats","pages":[{"title":"Show the member's dashboard","deprecated":null,"version":null,"openapi":"/api-reference/member-insights-v2026-10.yaml get /api/member/v2026-10/stats","href":"/api-reference/stats/show-the-members-dashboard"},{"title":"Rank the member's top assets","deprecated":null,"version":null,"openapi":"/api-reference/member-insights-v2026-10.yaml get /api/member/v2026-10/stats/top","href":"/api-reference/stats/rank-the-members-top-assets"},{"title":"Show the member's statistics for one asset","deprecated":null,"version":null,"openapi":"/api-reference/member-insights-v2026-10.yaml get /api/member/v2026-10/stats/assets/{kind}/{id}","href":"/api-reference/stats/show-the-members-statistics-for-one-asset"}]},{"group":"My Site","pages":[{"title":"Read MySite settings","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml get /api/member/v2026-10/mysite/settings","href":"/api-reference/mysite-settings/read-mysite-settings"},{"title":"Update supported MySite settings","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml patch /api/member/v2026-10/mysite/settings","href":"/api-reference/mysite-settings/update-supported-mysite-settings"},{"title":"List available MySite themes","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml get /api/member/v2026-10/mysite/themes","href":"/api-reference/mysite-themes/list-available-mysite-themes"},{"title":"List MySite custom links","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml get /api/member/v2026-10/mysite/links","href":"/api-reference/mysite-links/list-mysite-custom-links"},{"title":"Add a MySite custom link","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml post /api/member/v2026-10/mysite/links","href":"/api-reference/mysite-links/add-a-mysite-custom-link"},{"title":"Edit a MySite custom link","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml patch /api/member/v2026-10/mysite/links/{id}","href":"/api-reference/mysite-links/edit-a-mysite-custom-link"},{"title":"Delete a MySite custom link","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml delete /api/member/v2026-10/mysite/links/{id}","href":"/api-reference/mysite-links/delete-a-mysite-custom-link"},{"title":"Reorder MySite custom links","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml patch /api/member/v2026-10/mysite/links/reorder","href":"/api-reference/mysite-links/reorder-mysite-custom-links"},{"title":"List MySite featured products","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml get /api/member/v2026-10/mysite/favorites","href":"/api-reference/mysite-favorites/list-mysite-featured-products"},{"title":"Feature a product on MySite","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml post /api/member/v2026-10/mysite/favorites","href":"/api-reference/mysite-favorites/feature-a-product-on-mysite"},{"title":"Remove a MySite featured product","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml delete /api/member/v2026-10/mysite/favorites/{id}","href":"/api-reference/mysite-favorites/remove-a-mysite-featured-product"},{"title":"Reorder MySite featured products","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml patch /api/member/v2026-10/mysite/favorites/reorder","href":"/api-reference/mysite-favorites/reorder-mysite-featured-products"},{"title":"Read MySite statistics","deprecated":null,"version":null,"openapi":"/api-reference/member-themes-v2026-10.yaml get /api/member/v2026-10/mysite/stats","href":"/api-reference/mysite-stats/read-mysite-statistics"}]},{"group":"Messaging","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/conversations","href":"/api-reference/messaging/list-conversations"},{"title":"Start a conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations","href":"/api-reference/messaging/start-a-conversation"},{"title":"Show a conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/conversations/{id}","href":"/api-reference/messaging/show-a-conversation"},{"title":"Rename a conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml patch /api/member/v2026-10/messaging/conversations/{id}","href":"/api-reference/messaging/rename-a-conversation"},{"title":"Save a draft","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml put /api/member/v2026-10/messaging/conversations/{id}/draft","href":"/api-reference/messaging/save-a-draft"},{"title":"Delete a draft","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml delete /api/member/v2026-10/messaging/conversations/{id}/draft","href":"/api-reference/messaging/delete-a-draft"},{"title":"Archive a conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/archive","href":"/api-reference/messaging/archive-a-conversation"},{"title":"Unarchive a conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/unarchive","href":"/api-reference/messaging/unarchive-a-conversation"},{"title":"Mark a conversation read","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/read","href":"/api-reference/messaging/mark-a-conversation-read"},{"title":"Admit a realtime socket","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/realtime/auth","href":"/api-reference/messaging/admit-a-realtime-socket"},{"title":"Search people to message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/recipients/search","href":"/api-reference/messaging/search-people-to-message"},{"title":"Add people to a group","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/recipients","href":"/api-reference/messaging/add-people-to-a-group"},{"title":"Remove people from a group","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml delete /api/member/v2026-10/messaging/conversations/{id}/recipients","href":"/api-reference/messaging/remove-people-from-a-group"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/conversations/{id}/messages","href":"/api-reference/messaging/list-messages"},{"title":"Send a message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/messages","href":"/api-reference/messaging/send-a-message"},{"title":"List scheduled messages","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/scheduled-messages","href":"/api-reference/messaging/list-scheduled-messages"},{"title":"Change a scheduled message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml patch /api/member/v2026-10/messaging/conversations/{id}/scheduled-messages/{scheduled_message_id}","href":"/api-reference/messaging/change-a-scheduled-message"},{"title":"Cancel a scheduled message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml delete /api/member/v2026-10/messaging/conversations/{id}/scheduled-messages/{scheduled_message_id}","href":"/api-reference/messaging/cancel-a-scheduled-message"},{"title":"List a conversation's scheduled messages","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/conversations/{id}/scheduled-messages","href":"/api-reference/messaging/list-a-conversations-scheduled-messages"},{"title":"Schedule a message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/conversations/{id}/scheduled-messages","href":"/api-reference/messaging/schedule-a-message"},{"title":"Unpin a message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/messages/{id}/unpin","href":"/api-reference/messaging/unpin-a-message"},{"title":"React to a message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/messages/{id}/reactions","href":"/api-reference/messaging/react-to-a-message"},{"title":"Remove a reaction","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml delete /api/member/v2026-10/messaging/messages/{id}/reactions","href":"/api-reference/messaging/remove-a-reaction"},{"title":"Pin a message","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/messages/{id}/pin","href":"/api-reference/messaging/pin-a-message"},{"title":"List pinned messages","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/conversations/{id}/pinned","href":"/api-reference/messaging/list-pinned-messages"},{"title":"Mark an announcement read","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/announcements/{id}/read","href":"/api-reference/messaging/mark-an-announcement-read"},{"title":"List announcements","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/announcements","href":"/api-reference/messaging/list-announcements"},{"title":"Count unread conversations and messages","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/unread","href":"/api-reference/messaging/count-unread-conversations-and-messages"},{"title":"Read authorized share scheduling choices","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml get /api/member/v2026-10/messaging/share-schedules","href":"/api-reference/messaging/read-authorized-share-scheduling-choices"},{"title":"Schedule one explicitly selected share","deprecated":null,"version":null,"openapi":"/api-reference/member-messaging-v2026-10.yaml post /api/member/v2026-10/messaging/share-schedules","href":"/api-reference/messaging/schedule-one-explicitly-selected-share"}]},{"group":"Team","pages":[{"title":"List the member's Team","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team","href":"/api-reference/team/list-the-members-team"},{"title":"Summarize the member's Team","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/summary","href":"/api-reference/team/summarize-the-members-team"},{"title":"Count the Team members who joined in a period","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/growth","href":"/api-reference/team/count-the-team-members-who-joined-in-a-period"},{"title":"Count the Team by member type, rank and activity","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/composition","href":"/api-reference/team/count-the-team-by-member-type-rank-and-activity"},{"title":"Sum the Team's performance over a period","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/performance","href":"/api-reference/team/sum-the-teams-performance-over-a-period"},{"title":"Count the subscriptions the Team holds","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/subscriptions/summary","href":"/api-reference/team/count-the-subscriptions-the-team-holds"},{"title":"Count the subscriptions credited to the member and their Team","deprecated":null,"version":null,"openapi":"/api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/credited-subscriptions/summary","href":"/api-reference/team/count-the-subscriptions-credited-to-the-member-and-their-team"},{"title":"Read recorded relationship for member access","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}","href":"/api-reference/genealogy-history/read-recorded-relationship-for-member-access"},{"title":"List recorded placements for member access","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/placements","href":"/api-reference/genealogy-history/list-recorded-placements-for-member-access"},{"title":"Request a member genealogy move","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/member/v2026-10/team/{id}/move","href":"/api-reference/genealogy-moves/request-a-member-genealogy-move"},{"title":"Preview a member genealogy move","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/member/v2026-10/team/{id}/move/validate","href":"/api-reference/genealogy-moves/preview-a-member-genealogy-move"},{"title":"List own move requests","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/move-requests","href":"/api-reference/genealogy-moves/list-own-move-requests"},{"title":"Read own move request","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/move-requests/{id}","href":"/api-reference/genealogy-moves/read-own-move-request"},{"title":"Withdraw an own move request","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/member/v2026-10/team/move-requests/{id}/withdraw","href":"/api-reference/genealogy-moves/withdraw-an-own-move-request"},{"title":"Read an own durable move job","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/move-jobs/{id}","href":"/api-reference/genealogy-moves/read-an-own-durable-move-job"},{"title":"Page current team children","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/children","href":"/api-reference/genealogy-reads/page-current-team-children"},{"title":"Page current team descendants","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/descendants","href":"/api-reference/genealogy-reads/page-current-team-descendants"},{"title":"Page current team subtree","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/subtree","href":"/api-reference/genealogy-reads/page-current-team-subtree"},{"title":"Page one current team relative level","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/level","href":"/api-reference/genealogy-reads/page-one-current-team-relative-level"},{"title":"Count current team structural seats by relative level","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/member/v2026-10/team/{id}/level-counts","href":"/api-reference/genealogy-reads/count-current-team-structural-seats-by-relative-level"}]},{"group":"AI","pages":[{"title":"List AI conversations","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml get /api/member/v2026-10/ai/conversations","href":"/api-reference/ai/list-ai-conversations"},{"title":"Start an AI conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml post /api/member/v2026-10/ai/conversations","href":"/api-reference/ai/start-an-ai-conversation"},{"title":"Show an AI conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml get /api/member/v2026-10/ai/conversations/{id}","href":"/api-reference/ai/show-an-ai-conversation"},{"title":"Delete an AI conversation","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml delete /api/member/v2026-10/ai/conversations/{id}","href":"/api-reference/ai/delete-an-ai-conversation"},{"title":"Rate a reply","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml post /api/member/v2026-10/ai/messages/{id}/feedback","href":"/api-reference/ai/rate-a-reply"},{"title":"Stop the reply in progress","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml post /api/member/v2026-10/ai/conversations/{id}/stop","href":"/api-reference/ai/stop-the-reply-in-progress"},{"title":"Send a message to the assistant","deprecated":null,"version":null,"openapi":"/api-reference/member-ai-v2026-10.yaml post /api/member/v2026-10/ai/conversations/{id}/messages","href":"/api-reference/ai/send-a-message-to-the-assistant"}]},{"group":"Exigo data","pages":[{"title":"Read the member's Exigo figures","deprecated":null,"version":null,"openapi":"/api-reference/member-exigo-v2026-10.yaml get /api/member/v2026-10/exigo/{operation}","href":"/api-reference/exigo/read-the-members-exigo-figures"},{"title":"Read a team member's Exigo figures","deprecated":null,"version":null,"openapi":"/api-reference/member-exigo-v2026-10.yaml get /api/member/v2026-10/exigo/team/{exigo_id}/{operation}","href":"/api-reference/exigo/read-a-team-members-exigo-figures"}]}]},{"group":"Member Sites APIs","pages":[{"title":"Sites APIs","sidebarTitle":"Overview","href":"/api/member-sites"},{"group":"Sites","pages":[{"title":"List the member's sites","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites","href":"/api-reference/sites/list-the-members-sites"},{"title":"Add a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites","href":"/api-reference/sites/add-a-site"},{"title":"Show a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{id}","href":"/api-reference/sites/show-a-site"},{"title":"Change a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml patch /api/member/v2026-10/sites/{id}","href":"/api-reference/sites/change-a-site"},{"title":"Copy a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{id}/copy","href":"/api-reference/sites/copy-a-site"},{"title":"Get a sign-in handoff for a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/sign-in-handoffs","href":"/api-reference/sites/get-a-sign-in-handoff-for-a-site"},{"title":"List a site's branches","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/branches","href":"/api-reference/site-branches/list-a-sites-branches"},{"title":"Branch a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/branches","href":"/api-reference/site-branches/branch-a-site"},{"title":"Read a site's branch","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/branches/{slug}","href":"/api-reference/site-branches/read-a-sites-branch"},{"title":"Delete a site's branch","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/branches/{slug}","href":"/api-reference/site-branches/delete-a-sites-branch"}]},{"group":"Site sharing","pages":[{"title":"List a site's shares","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/shares","href":"/api-reference/site-shares/list-a-sites-shares"},{"title":"Share a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/shares","href":"/api-reference/site-shares/share-a-site"},{"title":"Change a share's permission","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml patch /api/member/v2026-10/sites/{site_id}/shares/{id}","href":"/api-reference/site-shares/change-a-shares-permission"},{"title":"Stop sharing with an audience","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/shares/{id}","href":"/api-reference/site-shares/stop-sharing-with-an-audience"},{"title":"Search the share targets","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/site-share-targets","href":"/api-reference/site-share-targets/search-the-share-targets"}]},{"group":"Site pins and home","pages":[{"title":"Pin a site to the member's menu","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/site-pins","href":"/api-reference/site-pins/pin-a-site-to-the-members-menu"},{"title":"Unpin a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/site-pins/{site_id}","href":"/api-reference/site-pins/unpin-a-site"},{"title":"Order the member's pins","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml put /api/member/v2026-10/site-pin-order","href":"/api-reference/site-pins/order-the-members-pins"},{"title":"Choose the member's home site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml put /api/member/v2026-10/site-home","href":"/api-reference/site-home/choose-the-members-home-site"},{"title":"Clear the member's home site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/site-home","href":"/api-reference/site-home/clear-the-members-home-site"}]},{"group":"Site bundles","pages":[{"title":"List a site's bundles","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/bundles","href":"/api-reference/site-bundles/list-a-sites-bundles"},{"title":"Start a bundle upload","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/bundles","href":"/api-reference/site-bundles/start-a-bundle-upload"},{"title":"Get a Git credential for a site's source","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/git-credential","href":"/api-reference/site-bundles/get-a-git-credential-for-a-sites-source"},{"title":"Publish a bundle","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/bundles/{bundle_id}/publish","href":"/api-reference/site-bundles/publish-a-bundle"},{"title":"Make an earlier bundle current (roll back)","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/bundles/{bundle_id}/current","href":"/api-reference/site-bundles/make-an-earlier-bundle-current-roll-back"}]},{"group":"Site hosting","pages":[{"title":"List a site's API keys","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/api-keys","href":"/api-reference/site-api-keys/list-a-sites-api-keys"},{"title":"Add an API key to a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/api-keys","href":"/api-reference/site-api-keys/add-an-api-key-to-a-site"},{"title":"Revoke a site's API key","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/api-keys/{key_id}","href":"/api-reference/site-api-keys/revoke-a-sites-api-key"},{"title":"List a site's environment variables","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/env-vars","href":"/api-reference/site-env-vars/list-a-sites-environment-variables"},{"title":"Set a site's environment variable","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml put /api/member/v2026-10/sites/{site_id}/env-vars/{name}","href":"/api-reference/site-env-vars/set-a-sites-environment-variable"},{"title":"Remove a site's environment variable","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/env-vars/{name}","href":"/api-reference/site-env-vars/remove-a-sites-environment-variable"},{"title":"List a site's deployments","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/deployments","href":"/api-reference/site-hosting/list-a-sites-deployments"},{"title":"Read a site's log","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/logs","href":"/api-reference/site-hosting/read-a-sites-log"},{"title":"Read a site's traffic","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/traffic","href":"/api-reference/site-hosting/read-a-sites-traffic"}]},{"group":"Site access requests","pages":[{"title":"List a site's access requests","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/access-requests","href":"/api-reference/site-access-requests/list-a-sites-access-requests"},{"title":"Approve an access request","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/access-requests/{id}/approve","href":"/api-reference/site-access-requests/approve-an-access-request"},{"title":"Decline an access request","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/access-requests/{id}/decline","href":"/api-reference/site-access-requests/decline-an-access-request"}]},{"group":"Site invitations","pages":[{"title":"List a site's invitations","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/invitations","href":"/api-reference/site-invitations/list-a-sites-invitations"},{"title":"Invite a member to a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/invitations","href":"/api-reference/site-invitations/invite-a-member-to-a-site"},{"title":"Revoke a site invitation","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/invitations/{id}","href":"/api-reference/site-invitations/revoke-a-site-invitation"},{"title":"List the member's site invitations","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/site-invitations","href":"/api-reference/site-invitations/list-the-members-site-invitations"},{"title":"Accept a site invitation","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/site-invitations/{id}/accept","href":"/api-reference/site-invitations/accept-a-site-invitation"},{"title":"Decline a site invitation","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/site-invitations/{id}/decline","href":"/api-reference/site-invitations/decline-a-site-invitation"},{"title":"Undo declining a site invitation","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/site-invitations/{id}/undo","href":"/api-reference/site-invitations/undo-declining-a-site-invitation"}]},{"group":"Site updates","pages":[{"title":"List the updates posted on a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/updates","href":"/api-reference/site-updates/list-the-updates-posted-on-a-site"},{"title":"Post an update on a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/updates","href":"/api-reference/site-updates/post-an-update-on-a-site"}]},{"group":"Site database","pages":[{"title":"Download a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/database-export","href":"/api-reference/site-database/download-a-sites-database"},{"title":"List the tables of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/data","href":"/api-reference/site-data/list-the-tables-of-a-sites-database"},{"title":"Read the rows of a table of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/data/{table}","href":"/api-reference/site-data/read-the-rows-of-a-table-of-a-sites-database"}]}]},{"group":"Member Sites compatibility","hidden":true,"pages":[{"group":"Account menu integration","pages":[{"title":"Show the member's account menu","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/site-menu","href":"/api-reference/site-menu/show-the-members-account-menu"},{"title":"Remove a site from the member's menu","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/site-removals","href":"/api-reference/site-removals/remove-a-site-from-the-members-menu"},{"title":"Restore a removed site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/site-removals/{id}","href":"/api-reference/site-removals/restore-a-removed-site"}]},{"group":"Liquid publishing and versions","pages":[{"title":"Publish a site","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{id}/publish","href":"/api-reference/sites/publish-a-site"},{"title":"List a site's versions","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{id}/versions","href":"/api-reference/sites/list-a-sites-versions"},{"title":"Restore a site to a version","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{id}/restore","href":"/api-reference/sites/restore-a-site-to-a-version"}]},{"group":"Liquid files and pages","pages":[{"title":"List a site's files","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/files","href":"/api-reference/site-files/list-a-sites-files"},{"title":"Show a site file","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/files/{path}","href":"/api-reference/site-files/show-a-site-file"},{"title":"Write a site file","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml put /api/member/v2026-10/sites/{site_id}/files/{path}","href":"/api-reference/site-files/write-a-site-file"},{"title":"Remove a site file","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/files/{path}","href":"/api-reference/site-files/remove-a-site-file"},{"title":"List a site's pages","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/pages","href":"/api-reference/site-pages/list-a-sites-pages"},{"title":"Add a page","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/pages","href":"/api-reference/site-pages/add-a-page"},{"title":"Change a page","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml patch /api/member/v2026-10/sites/{site_id}/pages/{page_id}","href":"/api-reference/site-pages/change-a-page"},{"title":"Remove a page","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/pages/{page_id}","href":"/api-reference/site-pages/remove-a-page"},{"title":"Preview the home page of a site's draft","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/preview/pages","href":"/api-reference/site-preview/preview-the-home-page-of-a-sites-draft"},{"title":"Preview a page of a site's draft","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/preview/pages/{slug}","href":"/api-reference/site-preview/preview-a-page-of-a-sites-draft"},{"title":"Read a text asset of a site's draft","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/preview/files/{path}","href":"/api-reference/site-preview/read-a-text-asset-of-a-sites-draft"}]},{"group":"Older database backend","pages":[{"title":"Show a site's database status","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/database","href":"/api-reference/site-database/show-a-sites-database-status"},{"title":"Turn on a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/database","href":"/api-reference/site-database/turn-on-a-sites-database"},{"title":"Turn off a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/database","href":"/api-reference/site-database/turn-off-a-sites-database"},{"title":"List the tables of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/database/tables","href":"/api-reference/site-database/list-the-tables-of-a-sites-database"},{"title":"Run a schema statement on a site's database","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/database/sql","href":"/api-reference/site-database/run-a-schema-statement-on-a-sites-database"},{"title":"List the rows of a table","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/database/tables/{table}/rows","href":"/api-reference/site-database/list-the-rows-of-a-table"},{"title":"Insert rows into a table","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/database/tables/{table}/rows","href":"/api-reference/site-database/insert-rows-into-a-table"},{"title":"Change a row","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml patch /api/member/v2026-10/sites/{site_id}/database/tables/{table}/rows/{id}","href":"/api-reference/site-database/change-a-row"},{"title":"Remove a row","deprecated":null,"version":null,"openapi":"/api-reference/member-sites-v2026-10.yaml delete /api/member/v2026-10/sites/{site_id}/database/tables/{table}/rows/{id}","href":"/api-reference/site-database/remove-a-row"}]},{"group":"Company Liquid publishing and versions","pages":[{"title":"Publish a company site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/publish","href":"/api-reference/member-sites/publish-a-company-site"},{"title":"List a site's versions","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/versions","href":"/api-reference/member-sites/list-a-sites-versions"},{"title":"Restore a site to a version","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/restore","href":"/api-reference/member-sites/restore-a-site-to-a-version"}]},{"group":"Company Liquid files and pages","pages":[{"title":"List a site's files","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/files","href":"/api-reference/member-site-files/list-a-sites-files"},{"title":"Show a site file","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/files/{path}","href":"/api-reference/member-site-files/show-a-site-file"},{"title":"Write a site file","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml put /api/company/v2026-10/member-sites/{id}/files/{path}","href":"/api-reference/member-site-files/write-a-site-file"},{"title":"Remove a site file","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/files/{path}","href":"/api-reference/member-site-files/remove-a-site-file"},{"title":"List a site's pages","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/pages","href":"/api-reference/member-site-pages/list-a-sites-pages"},{"title":"Add a page","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/pages","href":"/api-reference/member-site-pages/add-a-page"},{"title":"Change a page","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml patch /api/company/v2026-10/member-sites/{id}/pages/{page_id}","href":"/api-reference/member-site-pages/change-a-page"},{"title":"Remove a page","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/pages/{page_id}","href":"/api-reference/member-site-pages/remove-a-page"},{"title":"Preview the home page of a company site's draft","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/preview/pages","href":"/api-reference/member-site-preview/preview-the-home-page-of-a-company-sites-draft"},{"title":"Preview a page of a company site's draft","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/preview/pages/{slug}","href":"/api-reference/member-site-preview/preview-a-page-of-a-company-sites-draft"},{"title":"Read a text asset of a company site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/preview/files/{path}","href":"/api-reference/member-site-preview/read-a-text-asset-of-a-company-site"}]}]},{"group":"Messaging","pages":[{"group":"Channels","pages":[{"title":"List channel shares","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversation_shares","href":"/api-reference/messaging--conversations/list-channel-shares"},{"title":"Invite a company into a channel","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversation_shares","href":"/api-reference/messaging--conversations/invite-a-company-into-a-channel"},{"title":"End a channel share","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversation_shares/{id}","href":"/api-reference/messaging--conversations/end-a-channel-share"},{"title":"Accept a channel invitation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversation_shares/{id}/accept","href":"/api-reference/messaging--conversations/accept-a-channel-invitation"},{"title":"Add a colleague to a shared channel","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversation_shares/{id}/guests","href":"/api-reference/messaging--conversations/add-a-colleague-to-a-shared-channel"},{"title":"List conversations other companies share with you","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/shared_conversations","href":"/api-reference/messaging--conversations/list-conversations-other-companies-share-with-you"},{"title":"Get the announcement channel","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/announcement_channel","href":"/api-reference/messaging--conversations/get-the-announcement-channel"},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations","href":"/api-reference/messaging--conversations/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations","href":"/api-reference/messaging--conversations/create-a-conversation"},{"title":"List all conversations by template","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/all","href":"/api-reference/messaging--conversations/list-all-conversations-by-template"},{"title":"Bulk archive conversations","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/bulk_archive","href":"/api-reference/messaging--conversations/bulk-archive-conversations"},{"title":"Bulk delete conversations","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/bulk_delete","href":"/api-reference/messaging--conversations/bulk-delete-conversations"},{"title":"List connected recipients","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/connected_recipients","href":"/api-reference/messaging--conversations/list-connected-recipients"},{"title":"Find a conversation by contact","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/find","href":"/api-reference/messaging--conversations/find-a-conversation-by-contact"},{"title":"Get my downline conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/my_downline","href":"/api-reference/messaging--conversations/get-my-downline-conversation"},{"title":"Search your conversations","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/search","href":"/api-reference/messaging--conversations/search-your-conversations"},{"title":"Sync downline conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/sync_downline","href":"/api-reference/messaging--conversations/sync-downline-conversation"},{"title":"Archive a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/archive","href":"/api-reference/messaging--conversations/archive-a-conversation"},{"title":"Mute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/mute","href":"/api-reference/messaging--conversations/mute-a-conversation"},{"title":"Pin a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/pin","href":"/api-reference/messaging--conversations/pin-a-conversation"},{"title":"Mark conversation as read","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/read","href":"/api-reference/messaging--conversations/mark-conversation-as-read"},{"title":"Unarchive a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/unarchive","href":"/api-reference/messaging--conversations/unarchive-a-conversation"},{"title":"Unmute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/unmute","href":"/api-reference/messaging--conversations/unmute-a-conversation"},{"title":"Unpin a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/unpin","href":"/api-reference/messaging--conversations/unpin-a-conversation"},{"title":"Mark conversation as unread","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/unread","href":"/api-reference/messaging--conversations/mark-conversation-as-unread"},{"title":"Show a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{id}","href":"/api-reference/messaging--conversations/show-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{id}","href":"/api-reference/messaging--conversations/update-a-conversation"},{"title":"Delete a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{id}","href":"/api-reference/messaging--conversations/delete-a-conversation"},{"title":"Downgrade recipient access","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{id}/downgrade_access","href":"/api-reference/messaging--conversations/downgrade-recipient-access"},{"title":"Leave a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{id}/leave","href":"/api-reference/messaging--conversations/leave-a-conversation"},{"title":"Remove recipients from conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{id}/recipients/remove","href":"/api-reference/messaging--conversations/remove-recipients-from-conversation"},{"title":"Update conversation avatar","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml patch /api/v1/messaging/conversations/{id}/update_avatar","href":"/api-reference/messaging--conversations/update-conversation-avatar"},{"title":"Upgrade recipient access","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{id}/upgrade_access","href":"/api-reference/messaging--conversations/upgrade-recipient-access"},{"title":"Delete a recipient conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/recipient_conversations/{id}","href":"/api-reference/messaging--recipient-conversations/delete-a-recipient-conversation"}]},{"group":"Messages","pages":[{"title":"List a thread's replies","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/replies","href":"/api-reference/messaging--messages/list-a-threads-replies"},{"title":"Mark a thread read","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/thread_read","href":"/api-reference/messaging--messages/mark-a-thread-read"},{"title":"Mark unread from a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/mark_unread","href":"/api-reference/messaging--messages/mark-unread-from-a-message"},{"title":"List your unread threads","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/thread_unreads","href":"/api-reference/messaging--messages/list-your-unread-threads"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages","href":"/api-reference/messaging--messages/list-messages"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/messages","href":"/api-reference/messaging--messages/create-a-message"},{"title":"List pinned messages","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/pinned","href":"/api-reference/messaging--messages/list-pinned-messages"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/{id}","href":"/api-reference/messaging--messages/get-a-message"},{"title":"Update a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/messages/{id}","href":"/api-reference/messaging--messages/update-a-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/messages/{id}","href":"/api-reference/messaging--messages/delete-a-message"},{"title":"Pin a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/messages/{id}/pin","href":"/api-reference/messaging--messages/pin-a-message"},{"title":"Unpin a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/messages/{id}/unpin","href":"/api-reference/messaging--messages/unpin-a-message"},{"title":"React to a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/react","href":"/api-reference/messaging--messages/react-to-a-message"},{"title":"List reactions for a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/reactions","href":"/api-reference/messaging--messages/list-reactions-for-a-message"},{"title":"Reply to a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/reply","href":"/api-reference/messaging--messages/reply-to-a-message"},{"title":"Mark message as seen","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/seen","href":"/api-reference/messaging--messages/mark-message-as-seen"},{"title":"List recipients who saw a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/seen_by_recipients","href":"/api-reference/messaging--messages/list-recipients-who-saw-a-message"},{"title":"Remove reaction from a message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/messages/{message_id}/unreact","href":"/api-reference/messaging--messages/remove-reaction-from-a-message"},{"title":"Soft-delete a message for current user","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/my_messages/{id}","href":"/api-reference/messaging--my-messages/soft-delete-a-message-for-current-user"}]},{"group":"Today","pages":[{"title":"Read your Today access","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today","href":"/api-reference/messaging--today/read-your-today-access"},{"title":"List Today posts","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/posts","href":"/api-reference/messaging--today/list-today-posts"},{"title":"Post to Today","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/today/posts","href":"/api-reference/messaging--today/post-to-today"},{"title":"List archived Today posts","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/posts/archived","href":"/api-reference/messaging--today/list-archived-today-posts"},{"title":"Read a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/posts/{id}","href":"/api-reference/messaging--today/read-a-today-post"},{"title":"Edit your Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml patch /api/v1/messaging/today/posts/{id}","href":"/api-reference/messaging--today/edit-your-today-post"},{"title":"Delete a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/posts/{id}","href":"/api-reference/messaging--today/delete-a-today-post"},{"title":"Archive a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/today/posts/{id}/archive","href":"/api-reference/messaging--today/archive-a-today-post"},{"title":"Restore a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/posts/{id}/archive","href":"/api-reference/messaging--today/restore-a-today-post"},{"title":"Pin a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/today/posts/{id}/pin","href":"/api-reference/messaging--today/pin-a-today-post"},{"title":"Unpin a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/posts/{id}/pin","href":"/api-reference/messaging--today/unpin-a-today-post"},{"title":"Like a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/today/posts/{id}/like","href":"/api-reference/messaging--today/like-a-today-post"},{"title":"Unlike a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/posts/{id}/like","href":"/api-reference/messaging--today/unlike-a-today-post"},{"title":"List comments on a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/posts/{post_id}/comments","href":"/api-reference/messaging--today/list-comments-on-a-today-post"},{"title":"Comment on a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/today/posts/{post_id}/comments","href":"/api-reference/messaging--today/comment-on-a-today-post"},{"title":"Delete a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/comments/{id}","href":"/api-reference/messaging--today/delete-a-today-comment"},{"title":"Archive a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/today/comments/{id}/archive","href":"/api-reference/messaging--today/archive-a-today-comment"},{"title":"Restore a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/comments/{id}/archive","href":"/api-reference/messaging--today/restore-a-today-comment"},{"title":"Like a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/today/comments/{id}/like","href":"/api-reference/messaging--today/like-a-today-comment"},{"title":"Unlike a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/comments/{id}/like","href":"/api-reference/messaging--today/unlike-a-today-comment"},{"title":"Report a Today post","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/today/posts/{post_id}/reports","href":"/api-reference/messaging--today/report-a-today-post"},{"title":"List open Today reports","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/reports","href":"/api-reference/messaging--today/list-open-today-reports"},{"title":"Dismiss a Today report","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/today/reports/{id}","href":"/api-reference/messaging--today/dismiss-a-today-report"},{"title":"Find storefront items to share on Today","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/today/shareables","href":"/api-reference/messaging--today/find-storefront-items-to-share-on-today"},{"title":"Get your own link to a shared item","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/today/share_links","href":"/api-reference/messaging--today/get-your-own-link-to-a-shared-item"}]},{"group":"Drafts","pages":[{"title":"Delete a draft message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/destroy_draft","href":"/api-reference/messaging--drafts/delete-a-draft-message"},{"title":"Save a draft message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/save_draft","href":"/api-reference/messaging--drafts/save-a-draft-message"},{"title":"List all my draft messages","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/my_draft_messages","href":"/api-reference/messaging--drafts/list-all-my-draft-messages"}]},{"group":"Scheduled messages","pages":[{"title":"List scheduled messages in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/scheduled_messages","href":"/api-reference/messaging--scheduled-messages/list-scheduled-messages-in-a-conversation"},{"title":"Create a scheduled message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/scheduled_messages","href":"/api-reference/messaging--scheduled-messages/create-a-scheduled-message"},{"title":"Update a scheduled message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/conversations/{conversation_id}/scheduled_messages/{id}","href":"/api-reference/messaging--scheduled-messages/update-a-scheduled-message"},{"title":"Delete a scheduled message","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/scheduled_messages/{id}","href":"/api-reference/messaging--scheduled-messages/delete-a-scheduled-message"},{"title":"Deliver a scheduled message now","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/scheduled_messages/{id}/deliver","href":"/api-reference/messaging--scheduled-messages/deliver-a-scheduled-message-now"},{"title":"List all my scheduled messages","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/my_scheduled_messages","href":"/api-reference/messaging--scheduled-messages/list-all-my-scheduled-messages"}]},{"group":"Incoming webhooks","pages":[{"title":"List a conversation's incoming webhooks","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/incoming_webhooks","href":"/api-reference/messaging--incoming-webhooks/list-a-conversations-incoming-webhooks"},{"title":"Create an incoming webhook","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/incoming_webhooks","href":"/api-reference/messaging--incoming-webhooks/create-an-incoming-webhook"},{"title":"Revoke an incoming webhook","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/conversations/{conversation_id}/incoming_webhooks/{id}","href":"/api-reference/messaging--incoming-webhooks/revoke-an-incoming-webhook"},{"title":"Regenerate an incoming webhook's link","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/conversations/{conversation_id}/incoming_webhooks/{id}/regenerate","href":"/api-reference/messaging--incoming-webhooks/regenerate-an-incoming-webhooks-link"},{"title":"Post through an incoming webhook","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /webhooks/messaging/{token}","href":"/api-reference/messaging--incoming-webhooks/post-through-an-incoming-webhook"}]},{"group":"Recipients","pages":[{"title":"List recipients in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/recipients","href":"/api-reference/messaging--recipients/list-recipients-in-a-conversation"},{"title":"Get a recipient in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/{conversation_id}/recipients/{id}","href":"/api-reference/messaging--recipients/get-a-recipient-in-a-conversation"},{"title":"List blocked recipients","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/recipients/blocked","href":"/api-reference/messaging--recipients/list-blocked-recipients"},{"title":"Search recipients","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/recipients/search","href":"/api-reference/messaging--recipients/search-recipients"},{"title":"Block a recipient","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/recipients/{recipient_id}/block","href":"/api-reference/messaging--recipients/block-a-recipient"},{"title":"Unblock a recipient","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/recipients/{recipient_id}/unblock","href":"/api-reference/messaging--recipients/unblock-a-recipient"}]},{"group":"Bots","pages":[{"title":"List bots","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/bots","href":"/api-reference/messaging--bots/list-bots"},{"title":"Create a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml post /api/v1/messaging/bots","href":"/api-reference/messaging--bots/create-a-bot"},{"title":"Add bot to conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/bots/{bot_id}/add_to_conversation","href":"/api-reference/messaging--bots/add-bot-to-conversation"},{"title":"Remove bot from conversation","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/bots/{bot_id}/remove_from_conversation","href":"/api-reference/messaging--bots/remove-bot-from-conversation"},{"title":"Show a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml get /api/v1/messaging/bots/{id}","href":"/api-reference/messaging--bots/show-a-bot"},{"title":"Update a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/bots/{id}","href":"/api-reference/messaging--bots/update-a-bot"},{"title":"Delete a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml delete /api/v1/messaging/bots/{id}","href":"/api-reference/messaging--bots/delete-a-bot"},{"title":"Archive a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/bots/{id}/archive","href":"/api-reference/messaging--bots/archive-a-bot"},{"title":"Unarchive a bot","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/bots/{id}/unarchive","href":"/api-reference/messaging--bots/unarchive-a-bot"}]},{"group":"Profile","pages":[{"title":"Update messaging profile","deprecated":null,"version":null,"openapi":"/api-reference/messaging-v1.yaml put /api/v1/messaging/profile","href":"/api-reference/messaging--profiles/update-messaging-profile"}]},{"group":"Company messaging","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/messaging/conversations","href":"/api-reference/company-v0/company/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/messaging/conversations","href":"/api-reference/company-v0/company/create-a-conversation"},{"title":"Create a conversation message","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/messaging/conversations/{conversation_id}/messages","href":"/api-reference/company-v0/company/create-a-conversation-message"},{"title":"List conversation recipients","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/messaging/conversations/{conversation_id}/recipients","href":"/api-reference/company-v0/company/list-conversation-recipients"},{"title":"Get conversations","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/messaging/conversations/{id}","href":"/api-reference/company-v0/company/get-conversations"},{"title":"Search message recipients","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/messaging/recipients/search","href":"/api-reference/company-v0/company/search-message-recipients"},{"title":"Get Company Recipient Details","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/recipients/{recipientId}","href":"/api-reference/company-v0/recipients/get-company-recipient-details"}]},{"group":"Outbound messages","pages":[{"title":"Send an email","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/email","href":"/api-reference/outbound-messages/send-an-email"},{"title":"Send an SMS text message","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/sms","href":"/api-reference/outbound-messages/send-an-sms-text-message"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/whatsapp","href":"/api-reference/outbound-messages/send-a-whatsapp-message"},{"title":"Send a push notification","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/push","href":"/api-reference/outbound-messages/send-a-push-notification"},{"title":"Send on the member's preferred channel","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/preferred","href":"/api-reference/outbound-messages/send-on-the-members-preferred-channel"},{"title":"Send a Flow direct message","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messages/flow","href":"/api-reference/outbound-messages/send-a-flow-direct-message"},{"title":"Search outbound message history by phone, email, contact or customer","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/messages","href":"/api-reference/outbound-messages/search-outbound-message-history-by-phone-email-contact-or-customer"},{"title":"Get a message and its delivery history","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/messages/{id}","href":"/api-reference/outbound-messages/get-a-message-and-its-delivery-history"},{"title":"Show marketing send rules","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/messaging/send-rules","href":"/api-reference/outbound-messages/show-marketing-send-rules"},{"title":"Change marketing send rules","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml put /api/company/v2026-10/messaging/send-rules","href":"/api-reference/outbound-messages/change-marketing-send-rules"}]},{"group":"Contact methods","pages":[{"title":"List a member's contact methods","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/members/{member_id}/contact-methods","href":"/api-reference/contact-methods/list-a-members-contact-methods"},{"title":"List a contact's contact methods","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/contacts/{contact_id}/contact-methods","href":"/api-reference/contact-methods/list-a-contacts-contact-methods"},{"title":"Change a contact method","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml put /api/company/v2026-10/contact-methods/{id}","href":"/api-reference/contact-methods/change-a-contact-method"},{"title":"List a customer's contact methods","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/customers/{customer_id}/contact-methods","href":"/api-reference/contact-methods/list-a-customers-contact-methods"}]},{"group":"Flow senders","pages":[{"title":"List app senders","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/messaging/app-senders","href":"/api-reference/flow-senders/list-app-senders"},{"title":"Change an app sender","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml patch /api/company/v2026-10/messaging/app-senders/{id}","href":"/api-reference/flow-senders/change-an-app-sender"},{"title":"List your send delegations","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/messaging/send-delegations","href":"/api-reference/flow-senders/list-your-send-delegations"},{"title":"Let an app send as you","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml post /api/company/v2026-10/messaging/send-delegations","href":"/api-reference/flow-senders/let-an-app-send-as-you"},{"title":"Stop an app sending as you","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml delete /api/company/v2026-10/messaging/send-delegations/{id}","href":"/api-reference/flow-senders/stop-an-app-sending-as-you"}]},{"group":"Member devices","pages":[{"title":"Report desktop presence","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml put /api/company/v2026-10/devices/desktop","href":"/api-reference/devices/report-desktop-presence"},{"title":"List your devices","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml get /api/company/v2026-10/devices/mine","href":"/api-reference/devices/list-your-devices"},{"title":"Sign a device out","deprecated":null,"version":null,"openapi":"/api-reference/company-messages-v2026-10.yaml delete /api/company/v2026-10/devices/{id}","href":"/api-reference/devices/sign-a-device-out"}]},{"group":"Channel moderation","pages":[{"title":"Read channel messages","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/channel-messages","href":"/api-reference/channel-messages/read-channel-messages"},{"title":"Remove a channel message","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml delete /api/company/v2026-10/channel-messages/{id}","href":"/api-reference/channel-messages/remove-a-channel-message"},{"title":"Restore a removed channel message","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/channel-messages/{id}/restore","href":"/api-reference/channel-messages/restore-a-removed-channel-message"}]},{"group":"Today moderation","pages":[{"title":"List Today posts","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/today/posts","href":"/api-reference/messaging-today/list-today-posts"},{"title":"Get a Today post","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/today/posts/{id}","href":"/api-reference/messaging-today/get-a-today-post"},{"title":"Archive a Today post","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/today/posts/{id}/archive","href":"/api-reference/messaging-today/archive-a-today-post"},{"title":"Restore a Today post","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/today/posts/{id}/restore","href":"/api-reference/messaging-today/restore-a-today-post"},{"title":"Get a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/today/comments/{id}","href":"/api-reference/messaging-today/get-a-today-comment"},{"title":"Archive a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/today/comments/{id}/archive","href":"/api-reference/messaging-today/archive-a-today-comment"},{"title":"Restore a Today comment","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/today/comments/{id}/restore","href":"/api-reference/messaging-today/restore-a-today-comment"},{"title":"List open Today reports","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/today/reports","href":"/api-reference/messaging-today/list-open-today-reports"}]},{"group":"Messaging conversations","pages":[{"title":"Open a direct conversation","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/conversations","href":"/api-reference/messaging-conversations/open-a-direct-conversation"},{"title":"Post a message","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/conversations/{conversation_id}/messages","href":"/api-reference/messaging-conversations/post-a-message"},{"title":"Add someone to a conversation","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/conversations/{conversation_id}/recipients","href":"/api-reference/messaging-conversations/add-someone-to-a-conversation"},{"title":"Take someone out of a conversation","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml delete /api/company/v2026-10/messaging/conversations/{conversation_id}/recipients/{recipient_id}","href":"/api-reference/messaging-conversations/take-someone-out-of-a-conversation"},{"title":"React to a message","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml post /api/company/v2026-10/messaging/messages/{message_id}/reactions","href":"/api-reference/messaging-conversations/react-to-a-message"},{"title":"Take a reaction back","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml delete /api/company/v2026-10/messaging/messages/{message_id}/reactions","href":"/api-reference/messaging-conversations/take-a-reaction-back"}]}]},{"group":"Cowork","pages":[{"group":"Cowork tasks","pages":[{"title":"Read everything the task board draws","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/board","href":"/api-reference/cowork-tasks/read-everything-the-task-board-draws"},{"title":"List the company's work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/tasks","href":"/api-reference/cowork-tasks/list-the-companys-work"},{"title":"Submit standalone company work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks","href":"/api-reference/cowork-tasks/submit-standalone-company-work"},{"title":"Find people who can own company task work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/task-assignees","href":"/api-reference/cowork-tasks/find-people-who-can-own-company-task-work"},{"title":"Read a task's current snapshot","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/tasks/{id}","href":"/api-reference/cowork-tasks/read-a-tasks-current-snapshot"},{"title":"Change what the company's work says","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml patch /api/v202604/multiplayer/tasks/{id}","href":"/api-reference/cowork-tasks/change-what-the-companys-work-says"},{"title":"Delete the company's work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}","href":"/api-reference/cowork-tasks/delete-the-companys-work"},{"title":"Say how urgent the company's work is","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/priority","href":"/api-reference/cowork-tasks/say-how-urgent-the-companys-work-is"},{"title":"Say which day the company's work is due","description":"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. The version the client observed is compared with the stored one, so a date set against a stale view is refused and answered with the current task instead of merged. A null due_on clears the date, which is where every task starts. Work in another company, deleted work, and an unknown id all answer the same not-found; work deleted after that read and before the new date lands answers 410. A successful write announces a data-free invalidation on every theme this work's linked discussions sit on.","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/due-on","href":"/api-reference/cowork-tasks/say-which-day-the-companys-work-is-due"},{"title":"Place the company's work on the board","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/position","href":"/api-reference/cowork-tasks/place-the-companys-work-on-the-board"},{"title":"Say who owns the company's work","description":"Requires a user session with multiplayer_tasks.update or the existing application_themes.update permission. Work is assigned to an active, unlocked admin of the owning company or to nobody; the authenticated person is recorded as the assigner and is cleared along with the assignment. Mist is never an owner: it runs work for the person it is assigned to. A person who is not an admin here, and an id that names nobody, are both refused as an invalid assignment rather than reported as a missing task. The observed version is compared as it is for priority, and work deleted after that read and before the assignment lands answers 410 the same way. A successful write announces the same data-free invalidation.","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/assignee","href":"/api-reference/cowork-tasks/say-who-owns-the-companys-work"},{"title":"Record a person's verdict on the company's work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/status","href":"/api-reference/cowork-tasks/record-a-persons-verdict-on-the-companys-work"},{"title":"Rewrite what the company's work asks for","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/tasks/{id}/content","href":"/api-reference/cowork-tasks/rewrite-what-the-companys-work-asks-for"},{"title":"Read what changed on a task, and who changed it","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/tasks/{id}/history","href":"/api-reference/cowork-tasks/read-what-changed-on-a-task-and-who-changed-it"}]},{"group":"Task channels and attachments","pages":[{"title":"Attach an image or file to the company's work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{task_id}/attachments","href":"/api-reference/task-channels-and-attachments/attach-an-image-or-file-to-the-companys-work"},{"title":"Remove an image or file from the company's work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{task_id}/attachments/{id}","href":"/api-reference/task-channels-and-attachments/remove-an-image-or-file-from-the-companys-work"},{"title":"Open a ticket's comment channel","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/channel","href":"/api-reference/task-channels-and-attachments/open-a-tickets-comment-channel"},{"title":"Link a preview discussion to existing work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/source-threads","href":"/api-reference/task-channels-and-attachments/link-a-preview-discussion-to-existing-work"},{"title":"Take a preview discussion off its work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/source-threads/{thread_id}","href":"/api-reference/task-channels-and-attachments/take-a-preview-discussion-off-its-work"}]},{"group":"Task assessments","pages":[{"title":"Assess Mist's confidence in the work again","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{task_id}/assessments","href":"/api-reference/task-assessments/assess-mists-confidence-in-the-work-again"},{"title":"Answer the questions Mist asked about the work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{task_id}/assessments/{assessment_id}/answers","href":"/api-reference/task-assessments/answer-the-questions-mist-asked-about-the-work"},{"title":"Merge a ticket into the older one Mist read it as a repeat of","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/assessments/{assessment_id}/merge","href":"/api-reference/task-assessments/merge-a-ticket-into-the-older-one-mist-read-it-as-a-repeat-of"},{"title":"Say Mist's duplicate suggestion is not a duplicate","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/assessments/{assessment_id}/dismiss","href":"/api-reference/task-assessments/say-mists-duplicate-suggestion-is-not-a-duplicate"},{"title":"Take a merge back","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/split","href":"/api-reference/task-assessments/take-a-merge-back"}]},{"group":"Mist runs","pages":[{"title":"Save an authenticated Start in Mist instruction","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/start-requests","href":"/api-reference/mist-runs/save-an-authenticated-start-in-mist-instruction"},{"title":"Read a saved Start instruction and its task","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/tasks/{id}/start-requests/{request_id}","href":"/api-reference/mist-runs/read-a-saved-start-instruction-and-its-task"},{"title":"Take a Start back before Mist claims the task","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/start-requests/{request_id}","href":"/api-reference/mist-runs/take-a-start-back-before-mist-claims-the-task"},{"title":"Bind a saved Start instruction to one Desktop run claim","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/start-requests/{request_id}/accept","href":"/api-reference/mist-runs/bind-a-saved-start-instruction-to-one-desktop-run-claim"},{"title":"Send the company's work to a run","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/run","href":"/api-reference/mist-runs/send-the-companys-work-to-a-run"},{"title":"Take the company's work back from its run","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/run","href":"/api-reference/mist-runs/take-the-companys-work-back-from-its-run"},{"title":"End the run and store the answer it has to show","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/run/finish","href":"/api-reference/mist-runs/end-the-run-and-store-the-answer-it-has-to-show"},{"title":"Save a standalone Start result and finish its run atomically","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/run/finish-result","href":"/api-reference/mist-runs/save-a-standalone-start-result-and-finish-its-run-atomically"},{"title":"Ask Mist to check finished work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{task_id}/reviews","href":"/api-reference/mist-runs/ask-mist-to-check-finished-work"}]},{"group":"Agency requests","pages":[{"title":"List the agencies work can be sent to","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/agencies","href":"/api-reference/agency-requests/list-the-agencies-work-can-be-sent-to"},{"title":"Send the company's work to an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-requests","href":"/api-reference/agency-requests/send-the-companys-work-to-an-agency"},{"title":"Take the company's work back from an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/agency-request","href":"/api-reference/agency-requests/take-the-companys-work-back-from-an-agency"},{"title":"Ask for an agency Fluid does not have yet","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-join-requests","href":"/api-reference/agency-requests/ask-for-an-agency-fluid-does-not-have-yet"},{"title":"Cancel the ask for an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/agency-join-request","href":"/api-reference/agency-requests/cancel-the-ask-for-an-agency"},{"title":"Accept the agency's quote","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/accept-quote","href":"/api-reference/agency-requests/accept-the-agencys-quote"},{"title":"Decline the agency's quote","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/decline-quote","href":"/api-reference/agency-requests/decline-the-agencys-quote"},{"title":"Accept the agency's finished work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/accept-work","href":"/api-reference/agency-requests/accept-the-agencys-finished-work"},{"title":"Ask the agency for changes","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/refuse-work","href":"/api-reference/agency-requests/ask-the-agency-for-changes"},{"title":"Accept the agency's revised quote","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/accept-revision","href":"/api-reference/agency-requests/accept-the-agencys-revised-quote"},{"title":"Keep the original quote","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/decline-revision","href":"/api-reference/agency-requests/keep-the-original-quote"},{"title":"Reopen finished agency work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/reopen","href":"/api-reference/agency-requests/reopen-finished-agency-work"},{"title":"Give the agency's people access to the company's store","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{id}/agency-request/access","href":"/api-reference/agency-requests/give-the-agencys-people-access-to-the-companys-store"},{"title":"Take a person's store access away","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/tasks/{id}/agency-request/access/{user_id}","href":"/api-reference/agency-requests/take-a-persons-store-access-away"}]},{"group":"Discussions","pages":[{"title":"List the company's shared discussions","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions","href":"/api-reference/discussions/list-the-companys-shared-discussions"},{"title":"Start a shared company discussion","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions","href":"/api-reference/discussions/start-a-shared-company-discussion"},{"title":"Whether Mist Desktop saves chats here","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions/capability","href":"/api-reference/discussions/whether-mist-desktop-saves-chats-here"},{"title":"Read one shared discussion","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions/{id}","href":"/api-reference/discussions/read-one-shared-discussion"},{"title":"Share a chat with its work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/discussions/{id}/sharing","href":"/api-reference/discussions/share-a-chat-with-its-work"},{"title":"Make a chat private again","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/discussions/{id}/sharing","href":"/api-reference/discussions/make-a-chat-private-again"},{"title":"Read a discussion's saved decision cards","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions/{discussion_id}/decisions","href":"/api-reference/discussions/read-a-discussions-saved-decision-cards"},{"title":"Save one human answer or action choice","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/decisions/{id}/responses","href":"/api-reference/discussions/save-one-human-answer-or-action-choice"},{"title":"Read the reviews Mist saved in a discussion","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions/{discussion_id}/reviews","href":"/api-reference/discussions/read-the-reviews-mist-saved-in-a-discussion"},{"title":"Reopen the task a review found wrong","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/reviews/{id}/reopen","href":"/api-reference/discussions/reopen-the-task-a-review-found-wrong"},{"title":"Read a discussion's messages in order","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/discussions/{discussion_id}/messages","href":"/api-reference/discussions/read-a-discussions-messages-in-order"},{"title":"Add a person's message to a discussion","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/messages","href":"/api-reference/discussions/add-a-persons-message-to-a-discussion"},{"title":"Publish a client's answer to a person's question","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/answers","href":"/api-reference/discussions/publish-a-clients-answer-to-a-persons-question"},{"title":"Save the tool steps a client ran for a person's question","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/steps","href":"/api-reference/discussions/save-the-tool-steps-a-client-ran-for-a-persons-question"},{"title":"Claim the question a client is answering","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/multiplayer/discussions/{discussion_id}/answer-claim","href":"/api-reference/discussions/claim-the-question-a-client-is-answering"},{"title":"Release a client's claim","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/multiplayer/discussions/{discussion_id}/answer-claim","href":"/api-reference/discussions/release-a-clients-claim"},{"title":"Turn a discussion's saved messages into work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/discussions/{discussion_id}/task-links","href":"/api-reference/discussions/turn-a-discussions-saved-messages-into-work"}]},{"group":"Preview threads","pages":[{"title":"Discover existing preview threads across company themes","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/preview-threads","href":"/api-reference/preview-threads/discover-existing-preview-threads-across-company-themes"},{"title":"Read original preview context and a page of replies","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/preview-threads/{id}","href":"/api-reference/preview-threads/read-original-preview-context-and-a-page-of-replies"},{"title":"Read what changed on a preview thread acting as work","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/multiplayer/preview-threads/{id}/history","href":"/api-reference/preview-threads/read-what-changed-on-a-preview-thread-acting-as-work"}]},{"group":"Agency work","pages":[{"title":"List the agencies the caller belongs to","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/memberships","href":"/api-reference/agency-work/list-the-agencies-the-caller-belongs-to"},{"title":"List the tickets sent to an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/tasks","href":"/api-reference/agency-work/list-the-tickets-sent-to-an-agency"},{"title":"Read a ticket sent to an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/tasks/{id}","href":"/api-reference/agency-work/read-a-ticket-sent-to-an-agency"},{"title":"Read what changed on a ticket sent to an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/tasks/{id}/history","href":"/api-reference/agency-work/read-what-changed-on-a-ticket-sent-to-an-agency"},{"title":"Move a ticket sent to an agency","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/agencies/{agency}/tasks/{id}/status","href":"/api-reference/agency-work/move-a-ticket-sent-to-an-agency"},{"title":"Open the pickup owner's ticket messaging session","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/agencies/{agency}/tasks/{id}/channel-session","href":"/api-reference/agency-work/open-the-pickup-owners-ticket-messaging-session"},{"title":"Pick up a ticket, or hand it over","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/agencies/{agency}/tasks/{id}/pickup","href":"/api-reference/agency-work/pick-up-a-ticket-or-hand-it-over"},{"title":"Release a ticket","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/agencies/{agency}/tasks/{id}/pickup","href":"/api-reference/agency-work/release-a-ticket"},{"title":"Quote a ticket, or change the quote","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/agencies/{agency}/tasks/{id}/quote","href":"/api-reference/agency-work/quote-a-ticket-or-change-the-quote"},{"title":"Revise the quote while building","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml put /api/v202604/agencies/{agency}/tasks/{id}/revised-quote","href":"/api-reference/agency-work/revise-the-quote-while-building"},{"title":"Decline a ticket","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/agencies/{agency}/tasks/{id}/decline","href":"/api-reference/agency-work/decline-a-ticket"},{"title":"Propose a ticket's work done","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/agencies/{agency}/tasks/{id}/done","href":"/api-reference/agency-work/propose-a-tickets-work-done"},{"title":"List the people a ticket can be handed to","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/people","href":"/api-reference/agency-work/list-the-people-a-ticket-can-be-handed-to"}]},{"group":"Agency time","pages":[{"title":"Read the time recorded on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/tasks/{id}/time-entries","href":"/api-reference/agency-time/read-the-time-recorded-on-a-ticket"},{"title":"Log time on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/agencies/{agency}/tasks/{id}/time-entries","href":"/api-reference/agency-time/log-time-on-a-ticket"},{"title":"Read a person's time across tickets","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/time-entries","href":"/api-reference/agency-time/read-a-persons-time-across-tickets"},{"title":"Change a time entry","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml patch /api/v202604/agencies/{agency}/time-entries/{id}","href":"/api-reference/agency-time/change-a-time-entry"},{"title":"Delete a time entry","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/agencies/{agency}/time-entries/{id}","href":"/api-reference/agency-time/delete-a-time-entry"},{"title":"Start the timer on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml post /api/v202604/agencies/{agency}/tasks/{id}/timer","href":"/api-reference/agency-time/start-the-timer-on-a-ticket"},{"title":"Read the caller's running timer","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml get /api/v202604/agencies/{agency}/timer","href":"/api-reference/agency-time/read-the-callers-running-timer"},{"title":"Stop a running timer","deprecated":null,"version":null,"openapi":"/api-reference/multiplayer-v2026-04.yaml delete /api/v202604/agencies/{agency}/timer","href":"/api-reference/agency-time/stop-a-running-timer"}]}]},{"group":"People","pages":[{"group":"Members","pages":[{"title":"List members","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members","href":"/api-reference/members/list-members"},{"title":"Create a member","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml post /api/v2025-06/members","href":"/api-reference/members/create-a-member"},{"title":"Find a member by a unique identifier","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members/find","href":"/api-reference/members/find-a-member-by-a-unique-identifier"},{"title":"Get a member","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members/{member_id}","href":"/api-reference/members/get-a-member"},{"title":"Update a member","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml patch /api/v2025-06/members/{member_id}","href":"/api-reference/members/update-a-member"},{"title":"Exchange a member for a shopper token","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml post /api/v2025-06/members/{member_id}/customer-token-exchange","href":"/api-reference/members/exchange-a-member-for-a-shopper-token"},{"title":"Redeem a handoff token for a shopper session","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml post /api/v2025-06/members/{member_id}/customer-token-exchange/redeem","href":"/api-reference/members/redeem-a-handoff-token-for-a-shopper-session"},{"title":"Change a member's type","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml put /api/v2025-06/members/{member_id}/member-type","href":"/api-reference/members/change-a-members-type"},{"title":"Get a member's MySite theme","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members/{member_id}/mysite-theme","href":"/api-reference/members/get-a-members-mysite-theme"},{"title":"Change a member's MySite theme","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml put /api/v2025-06/members/{member_id}/mysite-theme","href":"/api-reference/members/change-a-members-mysite-theme"},{"title":"List a member's payment methods","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members/{member_id}/payment_methods","href":"/api-reference/members/list-a-members-payment-methods"},{"title":"Get a member's sponsor genealogy","deprecated":null,"version":null,"openapi":"/api-reference/members-v2025-06.yaml get /api/v2025-06/members/{member_id}/genealogy","href":"/api-reference/members/get-a-members-sponsor-genealogy"},{"title":"Discard a member","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/members/{member_id}","href":"/api-reference/members/discard-a-member"},{"title":"Create members in bulk","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/members/bulk","href":"/api-reference/members/create-members-in-bulk"},{"title":"Discard members in bulk","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/members/bulk","href":"/api-reference/members/discard-members-in-bulk"},{"title":"Create a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/reps","href":"/api-reference/reps/create-a-rep"},{"title":"List reps","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps","href":"/api-reference/reps/list-reps"},{"title":"Create multiple reps","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/reps/bulk","href":"/api-reference/reps/create-multiple-reps"},{"title":"Delete multiple reps","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/reps/bulk","href":"/api-reference/reps/delete-multiple-reps"},{"title":"Delete a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/reps/{id}","href":"/api-reference/reps/delete-a-rep"},{"title":"Get a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{id}","href":"/api-reference/reps/get-a-rep"},{"title":"Update a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/reps/{id}","href":"/api-reference/reps/update-a-rep"},{"title":"List credited orders for a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/credited_orders","href":"/api-reference/reps/list-credited-orders-for-a-rep"},{"title":"Get most shared resources","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/most_shared","href":"/api-reference/reps/get-most-shared-resources"},{"title":"Get most viewed resources","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/most_viewed","href":"/api-reference/reps/get-most-viewed-resources"},{"title":"List shared assets for a rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/shared_assets","href":"/api-reference/reps/list-shared-assets-for-a-rep"},{"title":"Get top products sold by rep","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/top_products_sold","href":"/api-reference/reps/get-top-products-sold-by-rep"},{"title":"Change a member's email address","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/members/{member_id}/change-email","href":"/api-reference/members/change-a-members-email-address"},{"group":"Legacy (v0)","pages":[{"title":"List reps","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/reps","href":"/api-reference/company-v0/reps/list-reps"},{"title":"Create a rep","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/reps","href":"/api-reference/company-v0/reps/create-a-rep"},{"title":"Get reps","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/reps/{id}","href":"/api-reference/company-v0/reps/get-reps"},{"title":"Update reps","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/reps/{id}","href":"/api-reference/company-v0/reps/update-reps"},{"title":"Delete reps","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/reps/{id}","href":"/api-reference/company-v0/reps/delete-reps"}]}]},{"group":"Member types","pages":[{"title":"List company member types","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/member-types","href":"/api-reference/members/list-company-member-types"},{"title":"Create a custom member type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/member-types","href":"/api-reference/members/create-a-custom-member-type"},{"title":"Show the default shopper member type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/member-types/default-shopper","href":"/api-reference/members/show-the-default-shopper-member-type"},{"title":"Set or clear the default shopper member type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/member-types/default-shopper","href":"/api-reference/members/set-or-clear-the-default-shopper-member-type"},{"title":"Update a member type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/member-types/{slug}","href":"/api-reference/members/update-a-member-type"},{"title":"Archive a custom member type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/member-types/{slug}","href":"/api-reference/members/archive-a-custom-member-type"}]},{"group":"Genealogy","pages":[{"title":"List tree definitions","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/trees","href":"/api-reference/genealogy-trees/list-tree-definitions"},{"title":"Add a tree definition","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/trees","href":"/api-reference/genealogy-trees/add-a-tree-definition"},{"title":"List tree keys","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/tree-keys","href":"/api-reference/genealogy-reads/list-tree-keys"},{"title":"Modify a tree definition","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml patch /api/company/v2026-10/genealogy/trees/{id}","href":"/api-reference/genealogy-trees/modify-a-tree-definition"},{"title":"Remove a custom tree definition","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml delete /api/company/v2026-10/genealogy/trees/{id}","href":"/api-reference/genealogy-trees/remove-a-custom-tree-definition"},{"title":"Resolve a member's primary seat in a tree","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/trees/{tree_id}/nodes","href":"/api-reference/genealogy-reads/resolve-a-members-primary-seat-in-a-tree"},{"title":"Place a member in a binary or matrix tree","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/trees/{tree_id}/nodes","href":"/api-reference/genealogy-placement/place-a-member-in-a-binary-or-matrix-tree"},{"title":"List the seats waiting in a tree's holding tank","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/trees/{tree_id}/holding-tank","href":"/api-reference/genealogy-placement/list-the-seats-waiting-in-a-trees-holding-tank"},{"title":"Mirror the enrollment tree into the placement tree","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/trees/{tree_id}/mirror-enrollment","href":"/api-reference/genealogy-placement/mirror-the-enrollment-tree-into-the-placement-tree"},{"title":"List placement mirror runs","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/mirror-runs","href":"/api-reference/genealogy-placement/list-placement-mirror-runs"},{"title":"Read a placement mirror run","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/mirror-runs/{id}","href":"/api-reference/genealogy-placement/read-a-placement-mirror-run"},{"title":"Read recorded relationship for company access","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}","href":"/api-reference/genealogy-history/read-recorded-relationship-for-company-access"},{"title":"Page the ancestor chain root first","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/ancestors","href":"/api-reference/genealogy-reads/page-the-ancestor-chain-root-first"},{"title":"Read the current parent node","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/parent","href":"/api-reference/genealogy-reads/read-the-current-parent-node"},{"title":"Read the current root node","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/root","href":"/api-reference/genealogy-reads/read-the-current-root-node"},{"title":"Read the current sponsor role parent","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/sponsor","href":"/api-reference/genealogy-reads/read-the-current-sponsor-role-parent"},{"title":"Read the current enroller role parent","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/enroller","href":"/api-reference/genealogy-reads/read-the-current-enroller-role-parent"},{"title":"Answer a current two-node relation","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/relation","href":"/api-reference/genealogy-reads/answer-a-current-two-node-relation"},{"title":"List recorded placements for company access","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/placements","href":"/api-reference/genealogy-history/list-recorded-placements-for-company-access"},{"title":"Place a seat waiting in the holding tank","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/nodes/{id}/place","href":"/api-reference/genealogy-placement/place-a-seat-waiting-in-the-holding-tank"},{"title":"Request a company genealogy move","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/nodes/{id}/move","href":"/api-reference/genealogy-moves/request-a-company-genealogy-move"},{"title":"Preview a company genealogy move","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/nodes/{id}/move/validate","href":"/api-reference/genealogy-moves/preview-a-company-genealogy-move"},{"title":"Read company move request","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/move-requests/{id}","href":"/api-reference/genealogy-moves/read-company-move-request"},{"title":"Approve a move request","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/move-requests/{id}/approve","href":"/api-reference/genealogy-moves/approve-a-move-request"},{"title":"Reject a move request","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml post /api/company/v2026-10/genealogy/move-requests/{id}/reject","href":"/api-reference/genealogy-moves/reject-a-move-request"},{"title":"Read a durable move job","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/move-jobs/{id}","href":"/api-reference/genealogy-moves/read-a-durable-move-job"},{"title":"List company move requests","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/trees/{tree_id}/move-requests","href":"/api-reference/genealogy-moves/list-company-move-requests"},{"title":"List tree move jobs","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/trees/{tree_id}/move-jobs","href":"/api-reference/genealogy-moves/list-tree-move-jobs"},{"title":"Page a member’s seats across trees","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/members/{member_id}/nodes","href":"/api-reference/genealogy-reads/page-a-member’s-seats-across-trees"},{"title":"Page current children","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/children","href":"/api-reference/genealogy-reads/page-current-children"},{"title":"Page current descendants","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/descendants","href":"/api-reference/genealogy-reads/page-current-descendants"},{"title":"Page current subtree","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/subtree","href":"/api-reference/genealogy-reads/page-current-subtree"},{"title":"Page one current relative level","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/level","href":"/api-reference/genealogy-reads/page-one-current-relative-level"},{"title":"Count current structural seats by relative level","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/level-counts","href":"/api-reference/genealogy-reads/count-current-structural-seats-by-relative-level"},{"title":"Page current siblings","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/siblings","href":"/api-reference/genealogy-reads/page-current-siblings"},{"title":"Page current frontline","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/frontline","href":"/api-reference/genealogy-reads/page-current-frontline"},{"title":"Page personally enrolled members","deprecated":null,"version":null,"openapi":"/api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/nodes/{id}/personally-enrolled","href":"/api-reference/genealogy-reads/page-personally-enrolled-members"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/customers","href":"/api-reference/customers/create-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/customers","href":"/api-reference/customers/list-customers"},{"title":"Create multiple customers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/customers/bulk","href":"/api-reference/customers/create-multiple-customers"},{"title":"Delete multiple customers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/customers/bulk","href":"/api-reference/customers/delete-multiple-customers"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/customers/{id}","href":"/api-reference/customers/delete-a-customer"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/customers/{id}","href":"/api-reference/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"Update a customer (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/customers/{id}","href":"/api-reference/customers/update-a-customer-put"},{"group":"Legacy (v0)","pages":[{"title":"List addresses","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/addresses","href":"/api-reference/company-v0/addresses/list-addresses"},{"title":"Create an address","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/addresses","href":"/api-reference/company-v0/addresses/create-an-address"},{"title":"Set an address as default","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/addresses/{address_id}/default","href":"/api-reference/company-v0/addresses/set-an-address-as-default"},{"title":"Get addresses","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/addresses/{id}","href":"/api-reference/company-v0/addresses/get-addresses"},{"title":"Update addresses","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/addresses/{id}","href":"/api-reference/company-v0/addresses/update-addresses"},{"title":"Delete addresses","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/addresses/{id}","href":"/api-reference/company-v0/addresses/delete-addresses"},{"title":"List customer notes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customer_notes","href":"/api-reference/company-v0/customernotes/list-customer-notes"},{"title":"Create a customer note","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customer_notes","href":"/api-reference/company-v0/customernotes/create-a-customer-note"},{"title":"Update a customer note","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customer_notes/{id}","href":"/api-reference/company-v0/customernotes/update-a-customer-note"},{"title":"Update a customer note (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/customer_notes/{id}","href":"/api-reference/company-v0/customernotes/update-a-customer-note-put"},{"title":"Delete a customer note","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/customer_notes/{id}","href":"/api-reference/company-v0/customernotes/delete-a-customer-note"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers","href":"/api-reference/company-v0/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customers","href":"/api-reference/company-v0/customers/create-a-customer"},{"title":"Bulk delete customers","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/customers/bulk_delete","href":"/api-reference/company-v0/customers/bulk-delete-customers"},{"title":"Export customers data in a CSV file","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customers/export_csv","href":"/api-reference/company-v0/customers/export-customers-data-in-a-csv-file"},{"title":"Import customers via csv file in the url","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customers/import_csv","href":"/api-reference/company-v0/customers/import-customers-via-csv-file-in-the-url"},{"title":"Look up customers for a picker","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers/lookup","href":"/api-reference/company-v0/customers/look-up-customers-for-a-picker"},{"title":"Generate a signed URL to upload csv for bulk importing customers","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customers/presigned_csv_url","href":"/api-reference/company-v0/customers/generate-a-signed-url-to-upload-csv-for-bulk-importing-customers"},{"title":"Get customers' stats","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers/stats","href":"/api-reference/company-v0/customers/get-customers-stats"},{"title":"Update specific fields of customer address","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{customer_id}/address/{address_id}","href":"/api-reference/company-v0/customers/update-specific-fields-of-customer-address"},{"title":"Update specific fields of customer address (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/customers/{customer_id}/address/{address_id}","href":"/api-reference/company-v0/customers/update-specific-fields-of-customer-address-put"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/customers/{customer_id}/address/{address_id}","href":"/api-reference/company-v0/customers/delete-customer-address"},{"title":"Set default address for customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{customer_id}/address/{address_id}/default","href":"/api-reference/company-v0/customers/set-default-address-for-customer"},{"title":"Get payment vault credentials","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers/{customer_id}/payment_methods/vault","href":"/api-reference/company-v0/customers/get-payment-vault-credentials"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers/{id}","href":"/api-reference/company-v0/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{id}","href":"/api-reference/company-v0/customers/update-a-customer"},{"title":"Update a customer (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/customers/{id}","href":"/api-reference/company-v0/customers/update-a-customer-put"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/customers/{id}","href":"/api-reference/company-v0/customers/delete-a-customer"},{"title":"Append metadata field","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{id}/append_metadata","href":"/api-reference/company-v0/customers/append-metadata-field"},{"title":"Add customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{id}/update_addresses","href":"/api-reference/company-v0/customers/add-customer-addresses"},{"title":"Update attributable rep for customer","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{id}/update_attributable_rep","href":"/api-reference/company-v0/customers/update-attributable-rep-for-customer"},{"title":"Update a customer's marketing preferences","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{id}/update_marketing_preferences","href":"/api-reference/company-v0/customers/update-a-customers-marketing-preferences"}]}]},{"group":"Admins","pages":[{"title":"List admins","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/admins","href":"/api-reference/admins/list-admins"},{"group":"Legacy (v0)","pages":[{"title":"List Company Users","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/users","href":"/api-reference/company-v0/users/list-company-users"},{"title":"Create Company User","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/users","href":"/api-reference/company-v0/users/create-company-user"},{"title":"Find a company user","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/users/find","href":"/api-reference/company-v0/company/find-a-company-user"},{"title":"Get Company User Details","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/users/{id}","href":"/api-reference/company-v0/users/get-company-user-details"},{"title":"Update Affiliate User Information","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/users/{id}","href":"/api-reference/company-v0/users/update-affiliate-user-information"},{"title":"Delete Company User","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/users/{id}","href":"/api-reference/company-v0/users/delete-company-user"},{"title":"Update a user's email signature","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/user_companies/{company_id}/update_email_signature","href":"/api-reference/company-v0/user-companies/update-a-users-email-signature"},{"title":"List favorites","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/user_companies/{user_company_id}/favorites","href":"/api-reference/company-v0/user-companies/list-favorites"},{"title":"Create a favorite","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/user_companies/{user_company_id}/favorites","href":"/api-reference/company-v0/user-companies/create-a-favorite"},{"title":"Bulk reorder favorites","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/user_companies/{user_company_id}/favorites/bulk_reorder","href":"/api-reference/company-v0/user-companies/bulk-reorder-favorites"},{"title":"Delete favorites","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/user_companies/{user_company_id}/favorites/{id}","href":"/api-reference/company-v0/user-companies/delete-favorites"},{"title":"List user notification prefs","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/user_notification_prefs","href":"/api-reference/company-v0/user-notification-prefs/list-user-notification-prefs"},{"title":"Apply a notification pref preset","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/user_notification_prefs/prefs_to_preset","href":"/api-reference/company-v0/user-notification-prefs/apply-a-notification-pref-preset"},{"title":"Bulk update user notification prefs","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/user_notification_prefs/update_prefs","href":"/api-reference/company-v0/user-notification-prefs/bulk-update-user-notification-prefs"},{"title":"Update user notification prefs","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/user_notification_prefs/{id}","href":"/api-reference/company-v0/user-notification-prefs/update-user-notification-prefs"},{"title":"Creates and invites a user","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/users/create_and_invite","href":"/api-reference/company-v0/users/creates-and-invites-a-user"},{"title":"Send a user invite","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/users/send_invite","href":"/api-reference/company-v0/users/send-a-user-invite"},{"title":"Update users","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/users/{id}","href":"/api-reference/company-v0/users/update-users"},{"title":"Update a user's roles","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/users/{user_id}/roles","href":"/api-reference/company-v0/users/update-a-users-roles"}]}]},{"group":"Contacts","pages":[{"title":"Create a company contact","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/contacts","href":"/api-reference/company-v0/company-contacts/create-a-company-contact"},{"title":"List company contacts","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/contacts","href":"/api-reference/company-v0/company-contacts/list-company-contacts"},{"title":"Queue a CSV export for company contacts","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/contacts/export_csv","href":"/api-reference/company-v0/contacts/queue-a-csv-export-for-company-contacts"},{"title":"Get Company User Details by email","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/contacts/find_by_email","href":"/api-reference/company-v0/contacts/get-company-user-details-by-email"},{"title":"Delete a company contact","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/contacts/{id}","href":"/api-reference/company-v0/company-contacts/delete-a-company-contact"},{"title":"Get a company contact","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/contacts/{id}","href":"/api-reference/company-v0/company-contacts/get-a-company-contact"},{"title":"Update a company contact","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/contacts/{id}","href":"/api-reference/company-v0/company-contacts/update-a-company-contact"},{"title":"Append metadata field","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/contacts/{id}/append_metadata","href":"/api-reference/company-v0/contacts/append-metadata-field"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/v3/contacts","href":"/api-reference/company-v0/contacts/list-contacts"}]},{"group":"Notes and activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/activities","href":"/api-reference/company-v0/activities/list-activities"},{"title":"Mark activities as read","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/activities/read","href":"/api-reference/company-v0/activities/mark-activities-as-read"},{"title":"Get activities","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/activities/{id}","href":"/api-reference/company-v0/activities/get-activities"},{"title":"Delete activities","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/activities/{id}","href":"/api-reference/company-v0/activities/delete-activities"},{"title":"Create a company activity","deprecated":false,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/activities","href":"/api-reference/company-v0/activities/create-a-company-activity"},{"title":"Create a custom activity","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/custom_activities","href":"/api-reference/company-v0/custom-activities/create-a-custom-activity"},{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/notes","href":"/api-reference/company-v0/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/notes","href":"/api-reference/company-v0/notes/create-a-note"},{"title":"Update notes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/notes/{id}","href":"/api-reference/company-v0/notes/update-notes"},{"title":"Delete notes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/notes/{id}","href":"/api-reference/company-v0/notes/delete-notes"},{"title":"List paginated user activities","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/v1.1/activities","href":"/api-reference/company-v0/activities/list-paginated-user-activities"}]},{"group":"Tasks","pages":[{"title":"Get tasks","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/tasks/{id}","href":"/api-reference/company-v0/tasks/get-tasks"},{"title":"Update tasks","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/tasks/{id}","href":"/api-reference/company-v0/tasks/update-tasks"},{"title":"Delete tasks","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/tasks/{id}","href":"/api-reference/company-v0/tasks/delete-tasks"},{"title":"Complete a task","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/tasks/{task_id}/complete","href":"/api-reference/company-v0/tasks/complete-a-task"}]},{"group":"Groups and labels","pages":[{"title":"List Labels","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/labels","href":"/api-reference/company-v0/labels/list-labels"},{"title":"Create Label","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/labels","href":"/api-reference/company-v0/labels/create-label"},{"title":"Clear Cache","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/labels/clear_cache","href":"/api-reference/company-v0/labels/clear-cache"},{"title":"List label icons","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/labels/icons","href":"/api-reference/company-v0/company/list-label-icons"},{"title":"Show Label","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/labels/{id}","href":"/api-reference/company-v0/labels/show-label"},{"title":"Update Label","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/labels/{id}","href":"/api-reference/company-v0/labels/update-label"},{"title":"Destroy Label","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/labels/{id}","href":"/api-reference/company-v0/labels/destroy-label"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/groups","href":"/api-reference/company-v0/groups/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/groups","href":"/api-reference/company-v0/groups/create-a-group"},{"title":"Add contacts to a group","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/groups/{group_id}/add_contacts","href":"/api-reference/company-v0/groups/add-contacts-to-a-group"},{"title":"Message all group contacts","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/groups/{group_id}/message_all","href":"/api-reference/company-v0/groups/message-all-group-contacts"},{"title":"Remove contacts from a group","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/groups/{group_id}/remove_contacts","href":"/api-reference/company-v0/groups/remove-contacts-from-a-group"},{"title":"Get groups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/groups/{id}","href":"/api-reference/company-v0/groups/get-groups"},{"title":"Update groups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/groups/{id}","href":"/api-reference/company-v0/groups/update-groups"},{"title":"Delete groups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/groups/{id}","href":"/api-reference/company-v0/groups/delete-groups"}]}]},{"group":"Payments","pages":[{"group":"Gateways","pages":[{"title":"List gateways","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml get /api/payment/v2026-04/gateways","href":"/api-reference/gateways/list-gateways"},{"title":"Create a gateway","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/gateways","href":"/api-reference/gateways/create-a-gateway"},{"title":"Get a gateway","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml get /api/payment/v2026-04/gateways/{id}","href":"/api-reference/gateways/get-a-gateway"},{"title":"Update a gateway","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml patch /api/payment/v2026-04/gateways/{id}","href":"/api-reference/gateways/update-a-gateway"},{"title":"Delete a gateway","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml delete /api/payment/v2026-04/gateways/{id}","href":"/api-reference/gateways/delete-a-gateway"},{"title":"Enable a gateway for one country","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/gateways/{id}/countries","href":"/api-reference/gateways/enable-a-gateway-for-one-country"},{"title":"Disable a gateway for one country","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml delete /api/payment/v2026-04/gateways/{id}/countries/{country_code}","href":"/api-reference/gateways/disable-a-gateway-for-one-country"},{"title":"Create a purchase transaction","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/gateways/{id}/purchase","href":"/api-reference/gateways/create-a-purchase-transaction"},{"title":"Create an authorization","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/gateways/{id}/authorize","href":"/api-reference/gateways/create-an-authorization"},{"title":"Verify a payment method ($0 auth)","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/gateways/{id}/verify","href":"/api-reference/gateways/verify-a-payment-method-$0-auth"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml get /api/payment/v2026-04/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml get /api/payment/v2026-04/transactions/{id}","href":"/api-reference/transactions/get-a-transaction"},{"title":"Capture an authorization","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/transactions/{id}/capture","href":"/api-reference/transactions/capture-an-authorization"},{"title":"Void an authorization","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/transactions/{id}/void","href":"/api-reference/transactions/void-an-authorization"},{"title":"Credit/refund a transaction","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/transactions/{id}/credit","href":"/api-reference/transactions/creditrefund-a-transaction"},{"title":"Company Transactions company transactions","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company_transactions","href":"/api-reference/company-transactions/company-transactions-company-transactions"},{"title":"Export Csv export csv","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company_transactions/export_csv","href":"/api-reference/company-transactions/export-csv-export-csv"},{"title":"Filter Options filter options","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company_transactions/filter_options","href":"/api-reference/company-transactions/filter-options-filter-options"},{"title":"Cancel authorized Bread payment transaction","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/payments/cancel/{order_token}","href":"/api-reference/payment/cancel-authorized-bread-payment-transaction"},{"title":"Approval Rate approval rate","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/approval_rate","href":"/api-reference/payments/approval-rate-approval-rate"},{"title":"Available Providers available providers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/available_providers","href":"/api-reference/payments/available-providers-available-providers"},{"title":"Average Latency average latency","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/average_latency","href":"/api-reference/payments/average-latency-average-latency"},{"title":"Average Latency By Provider average latency by provider","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/average_latency_by_provider","href":"/api-reference/payments/average-latency-by-provider-average-latency-by-provider"},{"title":"Error Rate error rate","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/error_rate","href":"/api-reference/payments/error-rate-error-rate"},{"title":"Kpis kpis","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/kpis","href":"/api-reference/payments/kpis-kpis"},{"title":"Transaction Amount transaction amount","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/transaction_amount","href":"/api-reference/payments/transaction-amount-transaction-amount"},{"title":"Transaction Volume transaction volume","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/transaction_volume","href":"/api-reference/payments/transaction-volume-transaction-volume"},{"title":"Settle authorized payment transaction","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/payments/settle","href":"/api-reference/payment/settle-authorized-payment-transaction"},{"title":"Tokenize credit card","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/payments/tokenize_card","href":"/api-reference/payment/tokenize-credit-card"},{"title":"Create payment record using payment account uuid and cart info","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/payments/{payment_account_id}","href":"/api-reference/payment/create-payment-record-using-payment-account-uuid-and-cart-info"},{"title":"List payment transactions with filtering, sorting, and pagination","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/transactions","href":"/api-reference/payment/list-payment-transactions-with-filtering-sorting-and-pagination"},{"title":"Export Csv export csv","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/transactions/export_csv","href":"/api-reference/transactions/export-csv-export-csv"},{"title":"List of filter options of transactions","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/transactions/filter_options","href":"/api-reference/payment/list-of-filter-options-of-transactions"}]},{"group":"Payment reports","pages":[{"title":"List the approval rate of each payment account","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/payments/payment-account-approval-rates","href":"/api-reference/payments-reports/list-the-approval-rate-of-each-payment-account"}]},{"group":"Billing pause","pages":[{"title":"Get a merchant's billing pause","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml get /api/payment/v2026-04/merchants/{merchant_id}/billing_pause","href":"/api-reference/merchant-billing-pause/get-a-merchants-billing-pause"},{"title":"Stop collecting money from this merchant's customers","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml post /api/payment/v2026-04/merchants/{merchant_id}/billing_pause","href":"/api-reference/merchant-billing-pause/stop-collecting-money-from-this-merchants-customers"},{"title":"Let this merchant collect money again","deprecated":null,"version":null,"openapi":"/api-reference/payment-v2026-04.yaml delete /api/payment/v2026-04/merchants/{merchant_id}/billing_pause","href":"/api-reference/merchant-billing-pause/let-this-merchant-collect-money-again"}]},{"group":"Cards and payment methods","pages":[{"title":"List saved cards","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/cards","href":"/api-reference/company-v0/cards/list-saved-cards"},{"title":"Create a card (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/cards","href":"/api-reference/company-v0/cards/create-a-card-deprecated"},{"title":"Charge a card","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/cards/{card_id}/charge","href":"/api-reference/company-v0/cards/charge-a-card"},{"title":"Set a card as default","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/cards/{card_id}/default","href":"/api-reference/company-v0/cards/set-a-card-as-default"},{"title":"Get cards","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/cards/{id}","href":"/api-reference/company-v0/cards/get-cards"},{"title":"Delete a saved card","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/cards/{id}","href":"/api-reference/company-v0/cards/delete-a-saved-card"},{"title":"List customer payment methods","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/customers/{customer_id}/payment_methods","href":"/api-reference/company-v0/admin-payment-methods/list-customer-payment-methods"},{"title":"Create customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/customers/{customer_id}/payment_methods","href":"/api-reference/company-v0/admin-payment-methods/create-customer-payment-method"},{"title":"Update customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/customers/{customer_id}/payment_methods/{id}","href":"/api-reference/company-v0/admin-payment-methods/update-customer-payment-method"},{"title":"Update customer payment method (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/customers/{customer_id}/payment_methods/{id}","href":"/api-reference/company-v0/admin-payment-methods/update-customer-payment-method-put"},{"title":"Delete customer payment method","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/customers/{customer_id}/payment_methods/{id}","href":"/api-reference/company-v0/admin-payment-methods/delete-customer-payment-method"},{"title":"List MCC codes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/mcc_codes","href":"/api-reference/company-v0/mcc-codes/list-mcc-codes"}]},{"group":"Payments onboarding","pages":[{"title":"List company bank accounts","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/bank_accounts","href":"/api-reference/bank-accounts/list-company-bank-accounts"},{"title":"Create company bank account","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/bank_accounts","href":"/api-reference/bank-accounts/create-company-bank-account"},{"title":"Get company bank account","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/bank_accounts/{id}","href":"/api-reference/bank-accounts/get-company-bank-account"},{"title":"Update company bank account","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml put /api/companies/{company_id}/bank_accounts/{id}","href":"/api-reference/bank-accounts/update-company-bank-account"},{"title":"Delete company bank account","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml delete /api/companies/{company_id}/bank_accounts/{id}","href":"/api-reference/bank-accounts/delete-company-bank-account"},{"title":"company countries retrieved","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/company_countries","href":"/api-reference/company-countries/company-countries-retrieved"},{"title":"Create company country","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/company_countries","href":"/api-reference/company-countries/create-company-country"},{"title":"Get company country","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/company_countries/{id}","href":"/api-reference/company-countries/get-company-country"},{"title":"Update company country","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml put /api/companies/{company_id}/company_countries/{id}","href":"/api-reference/company-countries/update-company-country"},{"title":"Delete company country","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml delete /api/companies/{company_id}/company_countries/{id}","href":"/api-reference/company-countries/delete-company-country"},{"title":"List company entities","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/entities","href":"/api-reference/entities/list-company-entities"},{"title":"Create company entity","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/entities","href":"/api-reference/entities/create-company-entity"},{"title":"Get company entity","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/entities/{id}","href":"/api-reference/entities/get-company-entity"},{"title":"Update company entity","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml put /api/companies/{company_id}/entities/{id}","href":"/api-reference/entities/update-company-entity"},{"title":"Delete company entity","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml delete /api/companies/{company_id}/entities/{id}","href":"/api-reference/entities/delete-company-entity"},{"title":"Get company onboarding info","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/onboarding_info","href":"/api-reference/onboarding-info/get-company-onboarding-info"},{"title":"Update company onboarding info","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml put /api/companies/{company_id}/onboarding_info","href":"/api-reference/onboarding-info/update-company-onboarding-info"},{"title":"Refresh expiring URL for company onboarding","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/onboarding_info/refresh_url","href":"/api-reference/onboarding-info/refresh-expiring-url-for-company-onboarding"},{"title":"Get terms and conditions URL for company onboarding","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/onboarding_info/terms_and_conditions","href":"/api-reference/onboarding-info/get-terms-and-conditions-url-for-company-onboarding"},{"title":"Upload document for company onboarding","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/onboarding_info/upload_document","href":"/api-reference/onboarding-info/upload-document-for-company-onboarding"},{"title":"List company owners","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/owners","href":"/api-reference/owners/list-company-owners"},{"title":"Create company owner","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/{company_id}/owners","href":"/api-reference/owners/create-company-owner"},{"title":"Get company owner","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml get /api/companies/{company_id}/owners/{id}","href":"/api-reference/owners/get-company-owner"},{"title":"Update company owner","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml put /api/companies/{company_id}/owners/{id}","href":"/api-reference/owners/update-company-owner"},{"title":"Delete company owner","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml delete /api/companies/{company_id}/owners/{id}","href":"/api-reference/owners/delete-company-owner"}]}]},{"group":"DAM","pages":[{"title":"Upload a file to the DAM","sidebarTitle":"Upload a file","href":"/api/dam-upload"},{"title":"Upload a private file","sidebarTitle":"Upload a private file","href":"/api/private-uploads"},{"group":"List and search assets","pages":[{"title":"Retrieves an asset by code","deprecated":null,"version":null,"openapi":"/api-reference/dam-v0.yaml get /api/dam/assets/{code}","href":"/api-reference/dam/retrieves-an-asset-by-code"},{"title":"Query DAM assets using tree paths and tags","deprecated":null,"version":null,"openapi":"/api-reference/dam-v0.yaml post /api/dam/query","href":"/api-reference/dam/query-dam-assets-using-tree-paths-and-tags"}]}]},{"group":"Website","pages":[{"group":"Themes","pages":[{"title":"List the company's themes","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes","href":"/api-reference/themes/list-the-companys-themes"},{"title":"Get one theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{id}","href":"/api-reference/themes/get-one-theme"},{"title":"Block or allow search engines for a theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml patch /api/v202604/themes/{id}","href":"/api-reference/themes/block-or-allow-search-engines-for-a-theme"},{"title":"List a theme's templates","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{theme_id}/templates","href":"/api-reference/themes/list-a-themes-templates"},{"title":"Get one template, with its Liquid body","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{theme_id}/templates/{id}","href":"/api-reference/themes/get-one-template-with-its-liquid-body"},{"title":"Get the active theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/active","href":"/api-reference/themes/get-the-active-theme"},{"title":"List the active theme's templates","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/active/templates","href":"/api-reference/themes/list-the-active-themes-templates"},{"title":"Render a draft member page or system screen","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/member-preview","href":"/api-reference/themes/render-a-draft-member-page-or-system-screen"},{"title":"Search real members for theme previews","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{theme_id}/member-preview/people","href":"/api-reference/themes/search-real-members-for-theme-previews"},{"title":"List application themes","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes","href":"/api-reference/application-themes/list-application-themes"},{"title":"Create an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes","href":"/api-reference/application-themes/create-an-application-theme"},{"title":"Get current active application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/active","href":"/api-reference/application-themes/get-current-active-application-theme"},{"title":"Import an application theme from zip file","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/import_zip","href":"/api-reference/application-themes/import-an-application-theme-from-zip-file"},{"title":"Get an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{id}","href":"/api-reference/application-themes/get-an-application-theme"},{"title":"Update an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml patch /api/application_themes/{id}","href":"/api-reference/application-themes/update-an-application-theme"},{"title":"Delete an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/application_themes/{id}","href":"/api-reference/application-themes/delete-an-application-theme"},{"title":"Returns available themeables for a given type scoped to the theme's company","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{id}/available_themeables","href":"/api-reference/application-themes/returns-available-themeables-for-a-given-type-scoped-to-the-themes-company"},{"title":"Clone an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/clone","href":"/api-reference/application-themes/clone-an-application-theme"},{"title":"Create a development reference clone of an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/clone_for_development","href":"/api-reference/application-themes/create-a-development-reference-clone-of-an-application-theme"},{"title":"Get a short-lived download URL for the theme at a past version","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{id}/git_archive_url","href":"/api-reference/application-themes/get-a-short-lived-download-url-for-the-theme-at-a-past-version"},{"title":"Connect the theme to a Git repository, provisioning one if needed","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/git_connect","href":"/api-reference/application-themes/connect-the-theme-to-a-git-repository-provisioning-one-if-needed"},{"title":"Restore the theme's draft content to a past published version","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/git_restore","href":"/api-reference/application-themes/restore-the-themes-draft-content-to-a-past-published-version"},{"title":"List a theme's published version history from its connected Git repo","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{id}/git_versions","href":"/api-reference/application-themes/list-a-themes-published-version-history-from-its-connected-git-repo"},{"title":"Import an application theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/import","href":"/api-reference/application-themes/import-an-application-theme"},{"title":"Publishes the theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{id}/publish","href":"/api-reference/application-themes/publishes-the-theme"},{"title":"Get theme assets","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{id}/theme_assets","href":"/api-reference/application-themes/get-theme-assets"},{"group":"Legacy (v0)","pages":[{"title":"List legacy themes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/legacy_themes","href":"/api-reference/company-v0/legacy-themes/list-legacy-themes"},{"title":"Create a legacy theme","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/legacy_themes","href":"/api-reference/company-v0/legacy-themes/create-a-legacy-theme"},{"title":"Get legacy themes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/legacy_themes/{id}","href":"/api-reference/company-v0/legacy-themes/get-legacy-themes"},{"title":"Update legacy themes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/legacy_themes/{id}","href":"/api-reference/company-v0/legacy-themes/update-legacy-themes"},{"title":"Delete legacy themes","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/legacy_themes/{id}","href":"/api-reference/company-v0/legacy-themes/delete-legacy-themes"}]}]},{"group":"Theme templates","pages":[{"title":"Lists all theme templates","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates","href":"/api-reference/applicationthemetemplates/lists-all-theme-templates"},{"title":"Creates a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates","href":"/api-reference/applicationthemetemplates/creates-a-theme-template"},{"title":"Retrieves a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates/{id}","href":"/api-reference/applicationthemetemplates/retrieves-a-theme-template"},{"title":"Updates a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml patch /api/application_theme_templates/{id}","href":"/api-reference/applicationthemetemplates/updates-a-theme-template"},{"title":"Deletes a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/application_theme_templates/{id}","href":"/api-reference/applicationthemetemplates/deletes-a-theme-template"},{"title":"Returns all available themeables for theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates/{id}/available_themeables","href":"/api-reference/applicationthemetemplates/returns-all-available-themeables-for-theme-template"},{"title":"Get available variables for a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates/{id}/available_variables","href":"/api-reference/applicationthemetemplates/get-available-variables-for-a-theme-template"},{"title":"Clones a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/{id}/clone","href":"/api-reference/applicationthemetemplates/clones-a-theme-template"},{"title":"Publishes the template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/{id}/publish","href":"/api-reference/applicationthemetemplates/publishes-the-template"},{"title":"Render a system screen in the selected member site's theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/render_page","href":"/api-reference/applicationthemetemplates/render-a-system-screen-in-the-selected-member-sites-theme"},{"title":"Renders a page for a theme template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/{id}/render_page","href":"/api-reference/applicationthemetemplates/renders-a-page-for-a-theme-template"},{"title":"Read a theme template version and its audit changes","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates/{id}/version_diff","href":"/api-reference/applicationthemetemplates/read-a-theme-template-version-and-its-audit-changes"},{"title":"Renders a section template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/{id}/render_section","href":"/api-reference/applicationthemetemplates/renders-a-section-template"},{"title":"Sets a theme template as default","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_theme_templates/{id}/set_default","href":"/api-reference/applicationthemetemplates/sets-a-theme-template-as-default"},{"title":"Updates themeable records to be used by the specified template","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml put /api/application_theme_templates/{id}/themeables_update","href":"/api-reference/applicationthemetemplates/updates-themeable-records-to-be-used-by-the-specified-template"}]},{"group":"Theme resources and files","pages":[{"title":"Lists all theme resources","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_themes/{application_theme_id}/resources","href":"/api-reference/applicationthemeresources/lists-all-theme-resources"},{"title":"Updates a theme resource","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml put /api/application_themes/{application_theme_id}/resources","href":"/api-reference/applicationthemeresources/updates-a-theme-resource"},{"title":"Deletes a theme resource","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/application_themes/{application_theme_id}/resources","href":"/api-reference/applicationthemeresources/deletes-a-theme-resource"},{"title":"Commits the theme's current state as one version","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{application_theme_id}/resources/sync","href":"/api-reference/applicationthemeresources/commits-the-themes-current-state-as-one-version"},{"title":"Check a theme push before uploading","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/application_themes/{application_theme_id}/resources/check_push","href":"/api-reference/applicationthemeresources/check-a-theme-push-before-uploading"},{"title":"Returns a list of file resources","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/file_resources","href":"/api-reference/file-resources/returns-a-list-of-file-resources"},{"title":"Creates a file resource","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/file_resources","href":"/api-reference/file-resources/creates-a-file-resource"},{"title":"Creates multiple file resources","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/file_resources/bulk_create","href":"/api-reference/file-resources/creates-multiple-file-resources"},{"title":"Deletes multiple file resources","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/file_resources/bulk_destroy","href":"/api-reference/file-resources/deletes-multiple-file-resources"},{"title":"Shows a file resource","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/file_resources/{id}","href":"/api-reference/file-resources/shows-a-file-resource"},{"title":"Deletes a file resource","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/file_resources/{id}","href":"/api-reference/file-resources/deletes-a-file-resource"}]},{"group":"Root themes","pages":[{"title":"Create a root theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/root_themes","href":"/api-reference/root-themes/create-a-root-theme"},{"title":"List company root themes","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/root_themes/my","href":"/api-reference/root-themes/list-company-root-themes"},{"title":"Update a root theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml patch /api/root_themes/{id}","href":"/api-reference/root-themes/update-a-root-theme"},{"title":"Delete a root theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/root_themes/{id}","href":"/api-reference/root-themes/delete-a-root-theme"}]},{"group":"Theme preview comments","pages":[{"title":"List a theme's preview comments","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{theme_id}/preview_comments","href":"/api-reference/preview-comments/list-a-themes-preview-comments"},{"title":"Pin a comment on a theme's preview","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/preview_comments","href":"/api-reference/preview-comments/pin-a-comment-on-a-themes-preview"},{"title":"Move a preview comment's status","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml patch /api/v202604/themes/{theme_id}/preview_comments/{client_id}","href":"/api-reference/preview-comments/move-a-preview-comments-status"},{"title":"Delete a preview comment","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml delete /api/v202604/themes/{theme_id}/preview_comments/{client_id}","href":"/api-reference/preview-comments/delete-a-preview-comment"},{"title":"Reply to a preview comment","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/preview_comments/{client_id}/replies","href":"/api-reference/preview-comments/reply-to-a-preview-comment"},{"title":"Set how urgent a preview comment is","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/{client_id}/priority","href":"/api-reference/preview-comments/set-how-urgent-a-preview-comment-is"},{"title":"Place a preview comment's card on the Tasks board","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/{client_id}/position","href":"/api-reference/preview-comments/place-a-preview-comments-card-on-the-tasks-board"},{"title":"Set who owns a preview comment","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/{client_id}/assignee","href":"/api-reference/preview-comments/set-who-owns-a-preview-comment"},{"title":"Claim a comment for one Mist run","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/preview_comments/{client_id}/run","href":"/api-reference/preview-comments/claim-a-comment-for-one-mist-run"},{"title":"Cancel the observed Mist run","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml delete /api/v202604/themes/{theme_id}/preview_comments/{client_id}/run","href":"/api-reference/preview-comments/cancel-the-observed-mist-run"},{"title":"Record that a Mist run is still alive","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/runs/{run_id}/check-in","href":"/api-reference/preview-comments/record-that-a-mist-run-is-still-alive"},{"title":"Record an unanswered turn without overriding a newer decision","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/preview_comments/{client_id}/backstop-reply","href":"/api-reference/preview-comments/record-an-unanswered-turn-without-overriding-a-newer-decision"},{"title":"Record a preview comment's proof baseline","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/{client_id}/proof_baseline","href":"/api-reference/preview-comments/record-a-preview-comments-proof-baseline"},{"title":"Record that a preview comment's change was published","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml put /api/v202604/themes/{theme_id}/preview_comments/{client_id}/published","href":"/api-reference/preview-comments/record-that-a-preview-comments-change-was-published"}]},{"group":"Theme releases","pages":[{"title":"List the theme's releases, newest first","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml get /api/company/theme_releases","href":"/api-reference/theme-releases/list-the-themes-releases-newest-first"},{"title":"Freeze the theme's current bindings as a new release","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/theme_releases","href":"/api-reference/theme-releases/freeze-the-themes-current-bindings-as-a-new-release"},{"title":"Serve a release","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/theme_releases/{id}/activate","href":"/api-reference/theme-releases/serve-a-release"},{"title":"Serve the release before the active one","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/theme_releases/rollback","href":"/api-reference/theme-releases/serve-the-release-before-the-active-one"}]},{"group":"Theme surfaces","pages":[{"title":"The theme's surfaces, each with its bindings","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml get /api/company/theme_surfaces","href":"/api-reference/theme-surfaces/the-themes-surfaces-each-with-its-bindings"},{"title":"Add a routable surface","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/theme_surfaces","href":"/api-reference/theme-surfaces/add-a-routable-surface"},{"title":"Change a surface's route or persona","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml patch /api/company/theme_surfaces/{id}","href":"/api-reference/theme-surfaces/change-a-surfaces-route-or-persona"},{"title":"Remove a surface and its bindings","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/theme_surfaces/{id}","href":"/api-reference/theme-surfaces/remove-a-surface-and-its-bindings"},{"title":"Point a surface at a template for an audience and channel","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml put /api/company/theme_surfaces/{id}/bind","href":"/api-reference/theme-surfaces/point-a-surface-at-a-template-for-an-audience-and-channel"},{"title":"Remove one of a surface's bindings","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/theme_surfaces/{id}/bind","href":"/api-reference/theme-surfaces/remove-one-of-a-surfaces-bindings"}]},{"group":"Theme audiences","pages":[{"title":"The theme's audiences","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml get /api/company/theme_audiences","href":"/api-reference/theme-audiences/the-themes-audiences"},{"title":"Add an audience","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/theme_audiences","href":"/api-reference/theme-audiences/add-an-audience"},{"title":"Change an audience's targeting","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml patch /api/company/theme_audiences/{id}","href":"/api-reference/theme-audiences/change-an-audiences-targeting"},{"title":"Remove an audience and the bindings that named it","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/theme_audiences/{id}","href":"/api-reference/theme-audiences/remove-an-audience-and-the-bindings-that-named-it"}]},{"group":"Member sites","pages":[{"title":"The theme's member sites, each with its pages","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml get /api/company/members_sites","href":"/api-reference/members-sites/the-themes-member-sites-each-with-its-pages"},{"title":"Add a member site to the theme","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/members_sites","href":"/api-reference/members-sites/add-a-member-site-to-the-theme"},{"title":"Change a member site's name, order, activity or rule","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml patch /api/company/members_sites/{id}","href":"/api-reference/members-sites/change-a-member-sites-name-order-activity-or-rule"},{"title":"Remove a member site and the pages it governs","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/members_sites/{id}","href":"/api-reference/members-sites/remove-a-member-site-and-the-pages-it-governs"},{"title":"Add a page to a member site","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/members_sites/{members_site_id}/pages","href":"/api-reference/members-pages/add-a-page-to-a-member-site"},{"title":"Change a member page's title, route, publication or site","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml patch /api/company/members_pages/{id}","href":"/api-reference/members-pages/change-a-member-pages-title-route-publication-or-site"},{"title":"Remove a member page","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/members_pages/{id}","href":"/api-reference/members-pages/remove-a-member-page"}]},{"group":"Company member sites","pages":[{"title":"Take a member site down","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/take-down","href":"/api-reference/member-sites/take-a-member-site-down"},{"title":"Bring back a member site that was taken down","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/reinstate","href":"/api-reference/member-sites/bring-back-a-member-site-that-was-taken-down"},{"title":"Lock a member site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/lock","href":"/api-reference/member-sites/lock-a-member-site"},{"title":"Unlock a member site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/unlock","href":"/api-reference/member-sites/unlock-a-member-site"},{"title":"Copy a member site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/copy","href":"/api-reference/member-sites/copy-a-member-site"},{"title":"List a site's branches","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/branches","href":"/api-reference/member-site-branches/list-a-sites-branches"},{"title":"Branch a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/branches","href":"/api-reference/member-site-branches/branch-a-site"},{"title":"Read a site's branch","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/branches/{slug}","href":"/api-reference/member-site-branches/read-a-sites-branch"},{"title":"Delete a site's branch","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/branches/{slug}","href":"/api-reference/member-site-branches/delete-a-sites-branch"}]},{"group":"Company site sharing and featuring","pages":[{"title":"List the featured sites","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-site-features","href":"/api-reference/member-site-features/list-the-featured-sites"},{"title":"Feature a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-site-features","href":"/api-reference/member-site-features/feature-a-site"},{"title":"Stop featuring a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-site-features/{site_id}","href":"/api-reference/member-site-features/stop-featuring-a-site"},{"title":"Order the featured sites","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml put /api/company/v2026-10/member-site-feature-order","href":"/api-reference/member-site-features/order-the-featured-sites"},{"title":"List a site's shares","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/shares","href":"/api-reference/member-site-shares/list-a-sites-shares"},{"title":"Share a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/shares","href":"/api-reference/member-site-shares/share-a-site"},{"title":"Change a share","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml patch /api/company/v2026-10/member-sites/{id}/shares/{share_id}","href":"/api-reference/member-site-shares/change-a-share"},{"title":"Delete a share","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/shares/{share_id}","href":"/api-reference/member-site-shares/delete-a-share"}]},{"group":"Company site bundles","pages":[{"title":"List a company site's bundles","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/bundles","href":"/api-reference/member-site-bundles/list-a-company-sites-bundles"},{"title":"Start a bundle upload for a company site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/bundles","href":"/api-reference/member-site-bundles/start-a-bundle-upload-for-a-company-site"},{"title":"Get a Git credential for a company site's source","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/git-credential","href":"/api-reference/member-site-bundles/get-a-git-credential-for-a-company-sites-source"},{"title":"Publish a company site's bundle","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/bundles/{bundle_id}/publish","href":"/api-reference/member-site-bundles/publish-a-company-sites-bundle"},{"title":"Make an earlier bundle of a company site current (roll back)","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/bundles/{bundle_id}/current","href":"/api-reference/member-site-bundles/make-an-earlier-bundle-of-a-company-site-current-roll-back"}]},{"group":"Company site updates","pages":[{"title":"List the updates posted on a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/updates","href":"/api-reference/member-site-updates/list-the-updates-posted-on-a-site"},{"title":"Post an update on a site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/updates","href":"/api-reference/member-site-updates/post-an-update-on-a-site"}]},{"group":"Company site hosting","pages":[{"title":"Recommend a site or an app for a new project","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/project-launch-recommendations","href":"/api-reference/member-site-conversion/recommend-a-site-or-an-app-for-a-new-project"},{"title":"Build a company site on Fluid","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/builds","href":"/api-reference/member-site-builds/build-a-company-site-on-fluid"},{"title":"Read a build of a company site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/builds/{build_id}","href":"/api-reference/member-site-builds/read-a-build-of-a-company-site"},{"title":"List a company site's API keys","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/api-keys","href":"/api-reference/member-site-api-keys/list-a-company-sites-api-keys"},{"title":"Add an API key to a company site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/api-keys","href":"/api-reference/member-site-api-keys/add-an-api-key-to-a-company-site"},{"title":"Revoke a company site's API key","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/api-keys/{key_id}","href":"/api-reference/member-site-api-keys/revoke-a-company-sites-api-key"},{"title":"List a company site's environment variables","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/env-vars","href":"/api-reference/member-site-env-vars/list-a-company-sites-environment-variables"},{"title":"Set a company site's environment variable","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml put /api/company/v2026-10/member-sites/{id}/env-vars/{name}","href":"/api-reference/member-site-env-vars/set-a-company-sites-environment-variable"},{"title":"Remove a company site's environment variable","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/env-vars/{name}","href":"/api-reference/member-site-env-vars/remove-a-company-sites-environment-variable"},{"title":"Convert a company site into a Mist app","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/conversion","href":"/api-reference/member-site-conversion/convert-a-company-site-into-a-mist-app"},{"title":"Read a site's conversion into a Mist app","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/conversion","href":"/api-reference/member-site-conversion/read-a-sites-conversion-into-a-mist-app"},{"title":"List a site's deployments","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/deployments","href":"/api-reference/member-site-hosting/list-a-sites-deployments"},{"title":"Read a company site's log","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/logs","href":"/api-reference/member-site-hosting/read-a-company-sites-log"},{"title":"Read a company site's traffic","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/traffic","href":"/api-reference/member-site-hosting/read-a-company-sites-traffic"}]},{"group":"Company site database","pages":[{"title":"List the tables of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/data","href":"/api-reference/member-site-data/list-the-tables-of-a-sites-database"},{"title":"Read the rows of a table of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/data/{table}","href":"/api-reference/member-site-data/read-the-rows-of-a-table-of-a-sites-database"},{"title":"Delete rows of a table of a site's database","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-sites/{id}/data/{table}","href":"/api-reference/member-site-data/delete-rows-of-a-table-of-a-sites-database"},{"title":"Download a site's database","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-sites/{id}/database-export","href":"/api-reference/member-site-database/download-a-sites-database"}]},{"group":"Company site policy","pages":[{"title":"Read the company's member site policy","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-site-policy","href":"/api-reference/member-site-policy/read-the-companys-member-site-policy"},{"title":"Replace the company's member site policy","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml put /api/company/v2026-10/member-site-policy","href":"/api-reference/member-site-policy/replace-the-companys-member-site-policy"}]},{"group":"Widget installations","pages":[{"title":"The widget packages this company has adopted","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml get /api/company/widget_installations","href":"/api-reference/widget-installations/the-widget-packages-this-company-has-adopted"},{"title":"Adopt a published widget package version","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml post /api/company/widget_installations","href":"/api-reference/widget-installations/adopt-a-published-widget-package-version"},{"title":"Narrow or widen what an installation may read","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml patch /api/company/widget_installations/{id}","href":"/api-reference/widget-installations/narrow-or-widen-what-an-installation-may-read"},{"title":"Stop an installation serving","deprecated":null,"version":null,"openapi":"/api-reference/theme-surfaces-v0.yaml delete /api/company/widget_installations/{id}","href":"/api-reference/widget-installations/stop-an-installation-serving"}]},{"group":"Theme sections","pages":[{"title":"List sections","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/sections","href":"/api-reference/company-v0/sections/list-sections"},{"title":"Get sections","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/sections/{id}","href":"/api-reference/company-v0/sections/get-sections"},{"title":"List paginated section items","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/sections/{id}/paginated_section_items","href":"/api-reference/company-v0/sections/list-paginated-section-items"}]},{"group":"Fonts","pages":[{"title":"List Google Fonts","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/google_fonts","href":"/api-reference/company-v0/google-fonts/list-google-fonts"}]},{"group":"Navigation menus","pages":[{"title":"List website navigation menus","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml get /api/menus","href":"/api-reference/menus/list-website-navigation-menus"},{"title":"Create a website navigation menu","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml post /api/menus","href":"/api-reference/menus/create-a-website-navigation-menu"},{"title":"Get a website navigation menu","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml get /api/menus/{id}","href":"/api-reference/menus/get-a-website-navigation-menu"},{"title":"Update a website navigation menu","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml patch /api/menus/{id}","href":"/api-reference/menus/update-a-website-navigation-menu"},{"title":"Delete a website navigation menu","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml delete /api/menus/{id}","href":"/api-reference/menus/delete-a-website-navigation-menu"},{"title":"Create a website menu item","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml post /api/menus/{menu_id}/menu_items","href":"/api-reference/menus/create-a-website-menu-item"},{"title":"Get a website menu item","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml get /api/menus/{menu_id}/menu_items/{id}","href":"/api-reference/menus/get-a-website-menu-item"},{"title":"Update a website menu item","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml put /api/menus/{menu_id}/menu_items/{id}","href":"/api-reference/menus/update-a-website-menu-item"},{"title":"Delete a website menu item","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml delete /api/menus/{menu_id}/menu_items/{id}","href":"/api-reference/menus/delete-a-website-menu-item"}]},{"group":"Redirects","pages":[{"title":"Lists redirects","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/redirects","href":"/api-reference/company-v0/redirects/lists-redirects"},{"title":"Create Redirect","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/redirects","href":"/api-reference/company-v0/redirects/create-redirect"},{"title":"Export redirects data in a CSV file","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/redirects/export_csv","href":"/api-reference/company-v0/redirects/export-redirects-data-in-a-csv-file"},{"title":"Import redirects via csv file in the url","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/redirects/import_csv","href":"/api-reference/company-v0/redirects/import-redirects-via-csv-file-in-the-url"},{"title":"Generate a signed URL to upload csv for bulk importing redirects","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/redirects/presigned_csv_url","href":"/api-reference/company-v0/redirects/generate-a-signed-url-to-upload-csv-for-bulk-importing-redirects"},{"title":"Retrieves a redirect","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/redirects/{id}","href":"/api-reference/company-v0/redirects/retrieves-a-redirect"},{"title":"Updates a redirect","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/redirects/{id}","href":"/api-reference/company-v0/redirects/updates-a-redirect"},{"title":"Deletes a redirect","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/redirects/{id}","href":"/api-reference/company-v0/redirects/deletes-a-redirect"}]},{"group":"Sitemap","pages":[{"title":"Get sitemap URLs","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/sitemap","href":"/api-reference/sitemap/get-sitemap-urls"},{"title":"Update sitemap URL visibility","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/sitemap","href":"/api-reference/sitemap/update-sitemap-url-visibility"},{"title":"List sitemap country routes (theme region rules)","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/theme_region_rules","href":"/api-reference/theme-region-rules/list-sitemap-country-routes-theme-region-rules"},{"title":"Create a sitemap country route (theme region rule)","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml post /api/theme_region_rules","href":"/api-reference/theme-region-rules/create-a-sitemap-country-route-theme-region-rule"},{"title":"Get a sitemap country route (theme region rule)","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/theme_region_rules/{id}","href":"/api-reference/theme-region-rules/get-a-sitemap-country-route-theme-region-rule"},{"title":"Update a sitemap country route (theme region rule)","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml patch /api/theme_region_rules/{id}","href":"/api-reference/theme-region-rules/update-a-sitemap-country-route-theme-region-rule"},{"title":"Delete a sitemap country route (theme region rule)","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml delete /api/theme_region_rules/{id}","href":"/api-reference/theme-region-rules/delete-a-sitemap-country-route-theme-region-rule"}]},{"group":"My Site","pages":[{"title":"Retrieves the default my site","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml get /api/default_my_sites","href":"/api-reference/defaultmysites/retrieves-the-default-my-site"},{"title":"Creates or updates the default my site","deprecated":null,"version":null,"openapi":"/api-reference/content-v0.yaml post /api/default_my_sites","href":"/api-reference/defaultmysites/creates-or-updates-the-default-my-site"},{"title":"List all mysite themes","deprecated":null,"version":null,"openapi":"/api-reference/themes-v0.yaml get /api/application_theme_templates/mysite_themes","href":"/api-reference/applicationthemetemplates/list-all-mysite-themes"}]},{"group":"Theme widgets","pages":[{"title":"Read the widget sharing capability","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/theme-widget-sharing/capability","href":"/api-reference/theme-widgets/read-the-widget-sharing-capability"},{"title":"List authoritative widget override paths","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/themes/{theme_id}/widget-shares/source","href":"/api-reference/theme-widgets/list-authoritative-widget-override-paths"},{"title":"Create an immutable widget share link","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/widget-shares","href":"/api-reference/theme-widgets/create-an-immutable-widget-share-link"},{"title":"Revoke a widget share link","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml delete /api/v202604/themes/{theme_id}/widget-shares/{id}","href":"/api-reference/theme-widgets/revoke-a-widget-share-link"},{"title":"Read shared widget metadata","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml get /api/v202604/theme-widget-shares/{token}","href":"/api-reference/theme-widgets/read-shared-widget-metadata"},{"title":"Import a shared widget into a theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/theme-widget-shares/{token}/imports","href":"/api-reference/theme-widgets/import-a-shared-widget-into-a-theme"},{"title":"Copy a native widget into a theme","deprecated":null,"version":null,"openapi":"/api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/native-widget-copies","href":"/api-reference/theme-widgets/copy-a-native-widget-into-a-theme"}]}]},{"group":"Portal","pages":[{"group":"Definitions","pages":[{"title":"List Fluid OS definitions","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions","href":"/api-reference/fluid-os--definitions/list-fluid-os-definitions"},{"title":"Create a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions","href":"/api-reference/fluid-os--definitions/create-a-fluid-os-definition"},{"title":"Get a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{id}","href":"/api-reference/fluid-os--definitions/get-a-fluid-os-definition"},{"title":"Update a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{id}","href":"/api-reference/fluid-os--definitions/update-a-fluid-os-definition"},{"title":"Delete a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{id}","href":"/api-reference/fluid-os--definitions/delete-a-fluid-os-definition"},{"title":"Mint a short-lived git credential for the portal definition repo","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{id}/git_credential","href":"/api-reference/fluid-os--definitions/mint-a-short-lived-git-credential-for-the-portal-definition-repo"}]},{"group":"Screens","pages":[{"title":"List screens for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/screens","href":"/api-reference/fluid-os--screens/list-screens-for-a-fluid-os-definition"},{"title":"Create a screen for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/screens","href":"/api-reference/fluid-os--screens/create-a-screen-for-a-fluid-os-definition"},{"title":"Get a specific screen","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/screens/{id}","href":"/api-reference/fluid-os--screens/get-a-specific-screen"},{"title":"Update a screen","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/screens/{id}","href":"/api-reference/fluid-os--screens/update-a-screen"},{"title":"Delete a screen","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{definition_id}/screens/{id}","href":"/api-reference/fluid-os--screens/delete-a-screen"}]},{"group":"Portal navigation","pages":[{"title":"List portal navigations","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/navigations","href":"/api-reference/fluid-os--navigations/list-portal-navigations"},{"title":"Create a portal navigation","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/navigations","href":"/api-reference/fluid-os--navigations/create-a-portal-navigation"},{"title":"Get a portal navigation","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/navigations/{id}","href":"/api-reference/fluid-os--navigations/get-a-portal-navigation"},{"title":"Update a portal navigation","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/navigations/{id}","href":"/api-reference/fluid-os--navigations/update-a-portal-navigation"},{"title":"Delete a portal navigation","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{definition_id}/navigations/{id}","href":"/api-reference/fluid-os--navigations/delete-a-portal-navigation"},{"title":"List portal navigation items","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/navigations/{navigation_id}/navigation_items","href":"/api-reference/fluid-os--navigation-items/list-portal-navigation-items"},{"title":"Create a portal navigation item","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/navigations/{navigation_id}/navigation_items","href":"/api-reference/fluid-os--navigation-items/create-a-portal-navigation-item"},{"title":"Get a portal navigation item","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/navigations/{navigation_id}/navigation_items/{id}","href":"/api-reference/fluid-os--navigation-items/get-a-portal-navigation-item"},{"title":"Update a portal navigation item","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/navigations/{navigation_id}/navigation_items/{id}","href":"/api-reference/fluid-os--navigation-items/update-a-portal-navigation-item"},{"title":"Delete a portal navigation item","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{definition_id}/navigations/{navigation_id}/navigation_items/{id}","href":"/api-reference/fluid-os--navigation-items/delete-a-portal-navigation-item"}]},{"group":"Profiles","pages":[{"title":"List profiles for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/profiles","href":"/api-reference/fluid-os--profiles/list-profiles-for-a-fluid-os-definition"},{"title":"Create a profile for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/profiles","href":"/api-reference/fluid-os--profiles/create-a-profile-for-a-fluid-os-definition"},{"title":"Get the default profile","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/profiles/default","href":"/api-reference/fluid-os--profiles/get-the-default-profile"},{"title":"Get a specific profile","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/profiles/{id}","href":"/api-reference/fluid-os--profiles/get-a-specific-profile"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/profiles/{id}","href":"/api-reference/fluid-os--profiles/update-a-profile"},{"title":"Delete a profile","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{definition_id}/profiles/{id}","href":"/api-reference/fluid-os--profiles/delete-a-profile"}]},{"group":"Portal themes","pages":[{"title":"List themes for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/themes","href":"/api-reference/fluid-os--themes/list-themes-for-a-fluid-os-definition"},{"title":"Create a theme for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/themes","href":"/api-reference/fluid-os--themes/create-a-theme-for-a-fluid-os-definition"},{"title":"Get a specific theme","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/themes/{id}","href":"/api-reference/fluid-os--themes/get-a-specific-theme"},{"title":"Update a theme","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/themes/{id}","href":"/api-reference/fluid-os--themes/update-a-theme"},{"title":"Delete a theme","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml delete /api/company/fluid_os/definitions/{definition_id}/themes/{id}","href":"/api-reference/fluid-os--themes/delete-a-theme"}]},{"group":"Versions","pages":[{"title":"List versions for a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/versions","href":"/api-reference/fluid-os--versions/list-versions-for-a-fluid-os-definition"},{"title":"Publish a new version of a Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/definitions/{definition_id}/versions","href":"/api-reference/fluid-os--versions/publish-a-new-version-of-a-fluid-os-definition"},{"title":"Get a specific version","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/definitions/{definition_id}/versions/{id}","href":"/api-reference/fluid-os--versions/get-a-specific-version"},{"title":"Update a version","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml put /api/company/fluid_os/definitions/{definition_id}/versions/{id}","href":"/api-reference/fluid-os--versions/update-a-version"}]},{"group":"Widget packages","pages":[{"title":"List Fluid OS widget packages","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/company/fluid_os/widget_packages","href":"/api-reference/fluid-os--widget-packages/list-fluid-os-widget-packages"},{"title":"Mint a short-lived git credential for the company widget repo","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml post /api/company/fluid_os/widget_package/git_credential","href":"/api-reference/fluid-os--widget-package-versions/mint-a-short-lived-git-credential-for-the-company-widget-repo"}]},{"group":"Active definition","pages":[{"title":"Get active Fluid OS definition","deprecated":null,"version":null,"openapi":"/api-reference/fluid-os-v0.yaml get /api/fluid_os/definitions/active","href":"/api-reference/fluid-os--public/get-active-fluid-os-definition"}]}]},{"group":"Mobile app","pages":[{"group":"Navigation","pages":[{"title":"List mobile app navigations","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml get /api/v2/mobile_navigations","href":"/api-reference/mobile-navigations/list-mobile-app-navigations"},{"title":"Create a mobile app navigation","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml post /api/v2/mobile_navigations","href":"/api-reference/mobile-navigations/create-a-mobile-app-navigation"},{"title":"List resources for mobile app navigation access rules","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml get /api/v2/mobile_navigations/available_resources","href":"/api-reference/mobile-navigations/list-resources-for-mobile-app-navigation-access-rules"},{"title":"Get a mobile app navigation","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml get /api/v2/mobile_navigations/{id}","href":"/api-reference/mobile-navigations/get-a-mobile-app-navigation"},{"title":"Update a mobile app navigation","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml patch /api/v2/mobile_navigations/{id}","href":"/api-reference/mobile-navigations/update-a-mobile-app-navigation"},{"title":"Delete a mobile app navigation","deprecated":null,"version":null,"openapi":"/api-reference/mobile-v2.yaml delete /api/v2/mobile_navigations/{id}","href":"/api-reference/mobile-navigations/delete-a-mobile-app-navigation"}]}]},{"group":"Content and tools","pages":[{"group":"Events","pages":[{"title":"Create company event","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml post /api/company/events","href":"/api-reference/company-events/create-company-event"},{"title":"List company events","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/events","href":"/api-reference/company-events/list-company-events"},{"title":"Update company event","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml patch /api/company/events/{eventId}","href":"/api-reference/company-events/update-company-event"},{"title":"Get company event","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/events/{eventId}","href":"/api-reference/company-events/get-company-event"},{"title":"Delete company event","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml delete /api/company/events/{eventId}","href":"/api-reference/company-events/delete-company-event"},{"title":"Send event notifications","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/events/{eventId}/send_notifications","href":"/api-reference/company-events/send-event-notifications"},{"group":"Legacy (v0)","pages":[{"title":"Bulk delete events","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/events/bulk_destroy","href":"/api-reference/company-v0/company/bulk-delete-events"},{"title":"Bulk update events","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/events/bulk_update","href":"/api-reference/company-v0/company/bulk-update-events"},{"title":"List paginated events","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/events/paginated","href":"/api-reference/company-v0/company/list-paginated-events"},{"title":"Duplicate an event","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/events/{id}/duplicate","href":"/api-reference/company-v0/company/duplicate-an-event"},{"title":"Get events","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/events/{id}","href":"/api-reference/company-v0/events/get-events"}]}]},{"group":"Forms","pages":[{"title":"List forms","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms","href":"/api-reference/forms/list-forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms","href":"/api-reference/forms/create-a-form"},{"title":"Get form statistics","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/statistics","href":"/api-reference/forms/get-form-statistics"},{"title":"List form elements","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{form_id}/form_elements","href":"/api-reference/form-elements/list-form-elements"},{"title":"Delete a form response","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml delete /api/forms/{form_id}/form_respondents/{id}","href":"/api-reference/forms/delete-a-form-response"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml put /api/forms/{id}","href":"/api-reference/forms/update-a-form"},{"title":"Delete a form","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml delete /api/forms/{id}","href":"/api-reference/forms/delete-a-form"},{"title":"Get form analytics","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/analytics","href":"/api-reference/forms/get-form-analytics"},{"title":"Duplicate a form","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/duplicate","href":"/api-reference/forms/duplicate-a-form"},{"title":"Get embed code","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/embed_code","href":"/api-reference/forms/get-embed-code"},{"title":"Update embed settings","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml patch /api/forms/{id}/embed_settings","href":"/api-reference/forms/update-embed-settings"},{"title":"Get the member-type audience","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/member_type_audience","href":"/api-reference/forms/get-the-member-type-audience"},{"title":"Replace the member-type audience","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml put /api/forms/{id}/member_type_audience","href":"/api-reference/forms/replace-the-member-type-audience"},{"title":"Clear the member-type audience","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml delete /api/forms/{id}/member_type_audience","href":"/api-reference/forms/clear-the-member-type-audience"},{"title":"Export form responses as CSV","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/export_csv","href":"/api-reference/forms/export-form-responses-as-csv"},{"title":"Generate a public token","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/generate_token","href":"/api-reference/forms/generate-a-public-token"},{"title":"List incomplete enrollees","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/incomplete_enrollees","href":"/api-reference/forms/list-incomplete-enrollees"},{"title":"Respond to a form","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/respond","href":"/api-reference/forms/respond-to-a-form"},{"title":"List form respondents","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/respondents","href":"/api-reference/forms/list-form-respondents"},{"title":"Revoke the public token","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml delete /api/forms/{id}/revoke_token","href":"/api-reference/forms/revoke-the-public-token"},{"title":"Send manual enrollment reminders","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/send_reminders","href":"/api-reference/forms/send-manual-enrollment-reminders"},{"title":"Send a form by email","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml post /api/forms/{id}/send_mail","href":"/api-reference/forms/send-a-form-by-email"},{"title":"Get answer breakdown","deprecated":null,"version":null,"openapi":"/api-reference/forms-v0.yaml get /api/forms/{id}/visualization","href":"/api-reference/forms/get-answer-breakdown"}]},{"group":"Mobile widgets","pages":[{"title":"Retrieve a paginated list of mobile widgets","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/mobile_widgets","href":"/api-reference/company-v0/mobile-widgets/retrieve-a-paginated-list-of-mobile-widgets"},{"title":"Create a new mobile widget","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/mobile_widgets","href":"/api-reference/company-v0/mobile-widgets/create-a-new-mobile-widget"},{"title":"Retrieve a specific mobile widget","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/mobile_widgets/{id}","href":"/api-reference/company-v0/mobile-widgets/retrieve-a-specific-mobile-widget"},{"title":"Update a mobile widget","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/mobile_widgets/{id}","href":"/api-reference/company-v0/mobile-widgets/update-a-mobile-widget"},{"title":"Delete a mobile widget","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/mobile_widgets/{id}","href":"/api-reference/company-v0/mobile-widgets/delete-a-mobile-widget"},{"title":"List mobile widgets","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/mobile_widgets","href":"/api-reference/company-v0/mobile-widgets/list-mobile-widgets"},{"title":"Get mobile widgets","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/mobile_widgets/{id}","href":"/api-reference/company-v0/mobile-widgets/get-mobile-widgets"}]},{"group":"Shares","pages":[{"title":"Get shares","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/shares","href":"/api-reference/company-v0/shares/get-shares"},{"title":"List Shares","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/shares","href":"/api-reference/company-v0/shares/list-shares"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/shares","href":"/api-reference/company-v0/shares/create-a-share-link"}]},{"group":"Search","pages":[{"title":"Global search across all searchable models","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/search","href":"/api-reference/company-v0/search/global-search-across-all-searchable-models"}]}]},{"group":"Analytics","pages":[{"group":"Home dashboard","pages":[{"title":"Home dashboard country selector options","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/countries","href":"/api-reference/analytics_dashboard_home_overview/home-dashboard-country-selector-options"},{"title":"Home > Overview header tiles (Yesterday, Revenue MTD, Tracking to)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/header","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-header-tiles-yesterday-revenue-mtd-tracking-to"},{"title":"Home > Overview payment-recovery card (recovered / retrying / written-off + trailing baseline)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/payment_recovery","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-payment-recovery-card-recovered-retrying-written-off-+-trailing-baseline"},{"title":"Home > Overview recent-orders card (latest paid orders feed)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/recent_orders","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-recent-orders-card-latest-paid-orders-feed"},{"title":"Home > Overview best-sellers card (top products ranked by revenue MTD)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/best_sellers","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-best-sellers-card-top-products-ranked-by-revenue-mtd"},{"title":"Home > Overview price-distribution card (catalogue histogram)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/price_distribution","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-price-distribution-card-catalogue-histogram"},{"title":"Home > Live header tiles (visitors now, revenue today, orders today, reps active)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_header","href":"/api-reference/analytics_dashboard_home_live/home->-live-header-tiles-visitors-now-revenue-today-orders-today-reps-active"},{"title":"Home > Live \"Today so far\" chart (cumulative today + same-DOW typical baseline)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_intraday","href":"/api-reference/analytics_dashboard_home_live/home->-live-\"today-so-far\"-chart-cumulative-today-+-same-dow-typical-baseline"},{"title":"Home > Live \"In motion\" card (active carts / abandoned / failed payments)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_money_in_motion","href":"/api-reference/analytics_dashboard_home_live/home->-live-\"in-motion\"-card-active-carts-abandoned-failed-payments"},{"title":"Home > Live \"Activity\" card (recent event stream)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_activity","href":"/api-reference/analytics_dashboard_home_live/home->-live-\"activity\"-card-recent-event-stream"},{"title":"Home > Live \"Top pages\" card (paths with active viewers right now)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_top_pages","href":"/api-reference/analytics_dashboard_home_live/home->-live-\"top-pages\"-card-paths-with-active-viewers-right-now"},{"title":"Home > Live \"Where they are\" card (visitors by country right now)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/live_where_they_are","href":"/api-reference/analytics_dashboard_home_live/home->-live-\"where-they-are\"-card-visitors-by-country-right-now"},{"title":"Home > Overview channel-economics card (per-channel revenue + $/visitor + delta)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/channel_economics","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-channel-economics-card-per-channel-revenue-+-$visitor-+-delta"},{"title":"Home > Overview subscription-engine card (4-week schedule + health tiles)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/subscription_engine","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-subscription-engine-card-4-week-schedule-+-health-tiles"},{"title":"Home > Overview revenue-quality card (new vs returning, subs vs one-time, AOV)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/revenue_quality","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-revenue-quality-card-new-vs-returning-subs-vs-one-time-aov"},{"title":"Home > Overview revenue-by-order-type card (two parallel stacked bars)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/order_composition","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-revenue-by-order-type-card-two-parallel-stacked-bars"},{"title":"Home > Overview cumulative-revenue trend chart with comparators + band","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/trend","href":"/api-reference/analytics_dashboard_home_overview/home->-overview-cumulative-revenue-trend-chart-with-comparators-+-band"},{"title":"Home > Field momentum header (Phase 003 Card 1)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/field_momentum","href":"/api-reference/analytics_dashboard_home_field/home->-field-momentum-header-phase-003-card-1"},{"title":"Home > Field 14-day rep activity chart (Phase 003 Card 2)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/field_activity_chart","href":"/api-reference/analytics_dashboard_home_field/home->-field-14-day-rep-activity-chart-phase-003-card-2"},{"title":"Home > Field \"Rising\" card (Phase 003 Card 3)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/field_rising_reps","href":"/api-reference/analytics_dashboard_home_field/home->-field-\"rising\"-card-phase-003-card-3"},{"title":"Home > Field \"Going quiet\" card (Phase 003 Card 4)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/field_going_quiet_reps","href":"/api-reference/analytics_dashboard_home_field/home->-field-\"going-quiet\"-card-phase-003-card-4"},{"title":"Home > Field \"Leaderboard\" card (Phase 003 Card 5)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/dashboard/field_leaderboard","href":"/api-reference/analytics_dashboard_home_field/home->-field-\"leaderboard\"-card-phase-003-card-5"},{"title":"Payment performance over a date range","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/payments/overview","href":"/api-reference/analytics_payments/payment-performance-over-a-date-range"}]},{"group":"Subscription billing","pages":[{"title":"Subscription Billing month grid (scheduled, at risk, settled)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/subscription_billing/calendar","href":"/api-reference/analytics_subscription_billing/subscription-billing-month-grid-scheduled-at-risk-settled"},{"title":"Subscription Billing month reporting (reasons, markets, timing)","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/subscription_billing/breakdown","href":"/api-reference/analytics_subscription_billing/subscription-billing-month-reporting-reasons-markets-timing"},{"title":"Subscription Billing one day's renewals, each with its risk band","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/subscription_billing/day","href":"/api-reference/analytics_subscription_billing/subscription-billing-one-days-renewals-each-with-its-risk-band"},{"title":"Subscription Billing one renewal's payment history","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/subscription_billing/renewal_history","href":"/api-reference/analytics_subscription_billing/subscription-billing-one-renewals-payment-history"}]},{"group":"Traffic","pages":[{"title":"Get analytics summary","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics","href":"/api-reference/analytics/get-analytics-summary"},{"title":"Get all analytics","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/all","href":"/api-reference/analytics/get-all-analytics"},{"title":"Get traffic campaign summary","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/campaign-summary","href":"/api-reference/analytics/get-traffic-campaign-summary"},{"title":"Search traffic campaign placements","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/campaign-placements","href":"/api-reference/analytics/search-traffic-campaign-placements"},{"title":"Get traffic campaigns","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/campaigns","href":"/api-reference/analytics/get-traffic-campaigns"},{"title":"Get traffic flows","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/flows","href":"/api-reference/analytics/get-traffic-flows"},{"title":"Get traffic geography","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/geography","href":"/api-reference/analytics/get-traffic-geography"},{"title":"Get traffic overview","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/overview","href":"/api-reference/analytics/get-traffic-overview"},{"title":"Get traffic by rep","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/reps","href":"/api-reference/analytics/get-traffic-by-rep"},{"title":"Get traffic sources","deprecated":null,"version":null,"openapi":"/api-reference/analytics-v0.yaml get /api/analytics/traffic/sources","href":"/api-reference/analytics/get-traffic-sources"}]},{"group":"Share stats","pages":[{"title":"List new and trending shareables","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/new_and_trending_shareables","href":"/api-reference/company-v0/new-and-trending-shareables/list-new-and-trending-shareables"},{"title":"Get share page stats","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/share_page_stats","href":"/api-reference/company-v0/share-page-stats/get-share-page-stats"}]},{"group":"Company health","pages":[{"title":"Read company health","deprecated":null,"version":null,"openapi":"/api-reference/company-health-v2026-10.yaml get /api/company/v2026-10/health","href":"/api-reference/company_health/read-company-health"},{"title":"Read one area's health","deprecated":null,"version":null,"openapi":"/api-reference/company-health-v2026-10.yaml get /api/company/v2026-10/health/{area}","href":"/api-reference/company_health/read-one-areas-health"},{"title":"Read one area's history","deprecated":null,"version":null,"openapi":"/api-reference/company-health-v2026-10.yaml get /api/company/v2026-10/health/{area}/history","href":"/api-reference/company_health/read-one-areas-history"}]}]},{"group":"Sales channels","pages":[{"group":"Amazon","pages":[{"title":"Get the company's Amazon connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/amazon/connection","href":"/api-reference/amazon/get-the-companys-amazon-connection"},{"title":"Select the connection's Amazon marketplace","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/amazon/connection","href":"/api-reference/amazon/select-the-connections-amazon-marketplace"},{"title":"Disconnect the company's Amazon connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/amazon/connection","href":"/api-reference/amazon/disconnect-the-companys-amazon-connection"},{"title":"Start the Amazon Seller Central consent flow","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/amazon/connection/authorize_url","href":"/api-reference/amazon/start-the-amazon-seller-central-consent-flow"},{"title":"List the company's Amazon orders","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/amazon/orders","href":"/api-reference/amazon/list-the-companys-amazon-orders"},{"title":"List the company's Amazon product listings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/amazon/product_listings","href":"/api-reference/amazon/list-the-companys-amazon-product-listings"},{"title":"Publish Fluid products as Amazon offers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/amazon/product_listings","href":"/api-reference/amazon/publish-fluid-products-as-amazon-offers"},{"title":"Unpublish an Amazon product listing","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/amazon/product_listings/{id}","href":"/api-reference/amazon/unpublish-an-amazon-product-listing"},{"title":"Retry a failed Amazon product listing publish","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/amazon/product_listings/{id}/retry","href":"/api-reference/amazon/retry-a-failed-amazon-product-listing-publish"}]},{"group":"Google","pages":[{"title":"Get the company's Google Merchant Center connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/google/connection","href":"/api-reference/google/get-the-companys-google-merchant-center-connection"},{"title":"Disconnect the company's Google Merchant Center connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/google/connection","href":"/api-reference/google/disconnect-the-companys-google-merchant-center-connection"},{"title":"Start the Google Merchant Center connect flow","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/google/connection/authorize_url","href":"/api-reference/google/start-the-google-merchant-center-connect-flow"},{"title":"List the company's Google Shopping listings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/google/product_listings","href":"/api-reference/google/list-the-companys-google-shopping-listings"},{"title":"Publish Fluid products to the connected Merchant Center","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/google/product_listings","href":"/api-reference/google/publish-fluid-products-to-the-connected-merchant-center"},{"title":"Unpublish a Google Shopping listing","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/google/product_listings/{id}","href":"/api-reference/google/unpublish-a-google-shopping-listing"},{"title":"Retry a failed Google Shopping listing publish","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/google/product_listings/{id}/retry","href":"/api-reference/google/retry-a-failed-google-shopping-listing-publish"}]},{"group":"Meta","pages":[{"title":"Get the company's Meta commerce connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/meta/connection","href":"/api-reference/meta/get-the-companys-meta-commerce-connection"},{"title":"Disconnect the company's Meta commerce connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/meta/connection","href":"/api-reference/meta/disconnect-the-companys-meta-commerce-connection"},{"title":"Start the Meta business-login connect flow","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/meta/connection/authorize_url","href":"/api-reference/meta/start-the-meta-business-login-connect-flow"},{"title":"Get the company's Meta catalog ads readiness","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/meta/ads_readiness","href":"/api-reference/meta/get-the-companys-meta-catalog-ads-readiness"},{"title":"List the company's Meta catalog listings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/meta/catalog_listings","href":"/api-reference/meta/list-the-companys-meta-catalog-listings"},{"title":"Publish Fluid products to the connected Meta catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/meta/catalog_listings","href":"/api-reference/meta/publish-fluid-products-to-the-connected-meta-catalog"},{"title":"Unpublish a Meta catalog listing","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/meta/catalog_listings/{id}","href":"/api-reference/meta/unpublish-a-meta-catalog-listing"},{"title":"Retry a failed Meta catalog listing publish","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/meta/catalog_listings/{id}/retry","href":"/api-reference/meta/retry-a-failed-meta-catalog-listing-publish"},{"title":"List the company's WhatsApp cart intents","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/meta/orders","href":"/api-reference/meta/list-the-companys-whatsapp-cart-intents"}]},{"group":"Pinterest","pages":[{"title":"Get the company's Pinterest connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/pinterest/connection","href":"/api-reference/pinterest/get-the-companys-pinterest-connection"},{"title":"Disconnect the company's Pinterest connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/pinterest/connection","href":"/api-reference/pinterest/disconnect-the-companys-pinterest-connection"},{"title":"Start the Pinterest connect flow","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/pinterest/connection/authorize_url","href":"/api-reference/pinterest/start-the-pinterest-connect-flow"},{"title":"List the company's Pinterest catalog listings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/pinterest/catalog_listings","href":"/api-reference/pinterest/list-the-companys-pinterest-catalog-listings"},{"title":"Publish Fluid products to the connected Pinterest catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/pinterest/catalog_listings","href":"/api-reference/pinterest/publish-fluid-products-to-the-connected-pinterest-catalog"},{"title":"Unpublish a Pinterest catalog listing","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/pinterest/catalog_listings/{id}","href":"/api-reference/pinterest/unpublish-a-pinterest-catalog-listing"},{"title":"Retry a failed Pinterest catalog listing publish","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/pinterest/catalog_listings/{id}/retry","href":"/api-reference/pinterest/retry-a-failed-pinterest-catalog-listing-publish"}]},{"group":"TikTok","pages":[{"title":"Get the company's TikTok Shop connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/connection","href":"/api-reference/tiktok/get-the-companys-tiktok-shop-connection"},{"title":"Configure the TikTok shop connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/tiktok/connection","href":"/api-reference/tiktok/configure-the-tiktok-shop-connection"},{"title":"Disconnect the company's TikTok Shop connection","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/tiktok/connection","href":"/api-reference/tiktok/disconnect-the-companys-tiktok-shop-connection"},{"title":"Start the TikTok OAuth connect flow","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/tiktok/connection/authorize_url","href":"/api-reference/tiktok/start-the-tiktok-oauth-connect-flow"},{"title":"Start the TikTok Creator Sales app authorization","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/tiktok/connection/creator-sales/authorize-url","href":"/api-reference/tiktok/start-the-tiktok-creator-sales-app-authorization"},{"title":"List the connected TikTok shop's logistics warehouses","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/warehouses","href":"/api-reference/tiktok/list-the-connected-tiktok-shops-logistics-warehouses"},{"title":"Browse the connected TikTok shop's categories","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/categories","href":"/api-reference/tiktok/browse-the-connected-tiktok-shops-categories"},{"title":"List the company's TikTok orders","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/orders","href":"/api-reference/tiktok/list-the-companys-tiktok-orders"},{"title":"List the company's TikTok creator mappings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/creator-mappings","href":"/api-reference/tiktok/list-the-companys-tiktok-creator-mappings"},{"title":"Map a TikTok creator to a member","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/tiktok/creator-mappings","href":"/api-reference/tiktok/map-a-tiktok-creator-to-a-member"},{"title":"Delete a TikTok creator mapping","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/tiktok/creator-mappings/{id}","href":"/api-reference/tiktok/delete-a-tiktok-creator-mapping"},{"title":"List the company's TikTok product listings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/tiktok/product_listings","href":"/api-reference/tiktok/list-the-companys-tiktok-product-listings"},{"title":"Publish Fluid products to the connected TikTok Shop","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/tiktok/product_listings","href":"/api-reference/tiktok/publish-fluid-products-to-the-connected-tiktok-shop"},{"title":"Set or clear a TikTok listing's category override","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/tiktok/product_listings/{id}","href":"/api-reference/tiktok/set-or-clear-a-tiktok-listings-category-override"},{"title":"Unpublish a TikTok product listing","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/tiktok/product_listings/{id}","href":"/api-reference/tiktok/unpublish-a-tiktok-product-listing"},{"title":"Retry a failed TikTok product listing publish","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/tiktok/product_listings/{id}/retry","href":"/api-reference/tiktok/retry-a-failed-tiktok-product-listing-publish"}]},{"group":"Ads","pages":[{"title":"List the Meta ad accounts and Pages the connection can reach","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/meta/ad-accounts","href":"/api-reference/ads/list-the-meta-ad-accounts-and-pages-the-connection-can-reach"},{"title":"Get the selected Meta ad account","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/meta/ad-account","href":"/api-reference/ads/get-the-selected-meta-ad-account"},{"title":"Select the Meta ad account to advertise from","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v202506/company/ads/meta/ad-account","href":"/api-reference/ads/select-the-meta-ad-account-to-advertise-from"},{"title":"Clear the selected Meta ad account","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/company/ads/meta/ad-account","href":"/api-reference/ads/clear-the-selected-meta-ad-account"},{"title":"List the Google Ads accounts the connection can reach","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/google/ad-accounts","href":"/api-reference/ads/list-the-google-ads-accounts-the-connection-can-reach"},{"title":"Get the selected Google Ads account","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/google/ad-account","href":"/api-reference/ads/get-the-selected-google-ads-account"},{"title":"Select the Google Ads account to advertise from","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v202506/company/ads/google/ad-account","href":"/api-reference/ads/select-the-google-ads-account-to-advertise-from"},{"title":"Clear the selected Google Ads account","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/company/ads/google/ad-account","href":"/api-reference/ads/clear-the-selected-google-ads-account"},{"title":"List the company's ads launches","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/meta/launches","href":"/api-reference/ads/list-the-companys-ads-launches"},{"title":"Launch a paused Meta campaign","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/company/ads/meta/launches","href":"/api-reference/ads/launch-a-paused-meta-campaign"},{"title":"List the company's Google ads launches","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/google/launches","href":"/api-reference/ads/list-the-companys-google-ads-launches"},{"title":"Launch a paused Google Search campaign","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/company/ads/google/launches","href":"/api-reference/ads/launch-a-paused-google-search-campaign"},{"title":"Read a Meta launch's campaign results","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/meta/launches/{id}/insights","href":"/api-reference/ads/read-a-meta-launchs-campaign-results"},{"title":"Read a Google launch's campaign results","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/google/launches/{id}/insights","href":"/api-reference/ads/read-a-google-launchs-campaign-results"},{"title":"Generate ad images at an aspect ratio","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/company/ads/images","href":"/api-reference/ads/generate-ad-images-at-an-aspect-ratio"},{"title":"Read an ad image generation","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company/ads/images/{id}","href":"/api-reference/ads/read-an-ad-image-generation"}]}]},{"group":"Settings","pages":[{"group":"Agreements","pages":[{"title":"Lists agreements","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/agreements","href":"/api-reference/company-v0/agreements/lists-agreements"},{"title":"Creates an agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/agreements","href":"/api-reference/company-v0/agreements/creates-an-agreement"},{"title":"Clones multiple agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/agreements/bulk_clone","href":"/api-reference/company-v0/agreements/clones-multiple-agreement"},{"title":"Bulk deletes agreements","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/agreements/bulk_delete","href":"/api-reference/company-v0/agreements/bulk-deletes-agreements"},{"title":"Retrieves an agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/agreements/{id}","href":"/api-reference/company-v0/agreements/retrieves-an-agreement"},{"title":"Updates an agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/agreements/{id}","href":"/api-reference/company-v0/agreements/updates-an-agreement"},{"title":"Deletes an agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/agreements/{id}","href":"/api-reference/company-v0/agreements/deletes-an-agreement"},{"title":"Clones an agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/agreements/{id}/clone","href":"/api-reference/company-v0/agreements/clones-an-agreement"},{"title":"Create a user agreement","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/user_agreements","href":"/api-reference/company-v0/company/create-a-user-agreement"},{"title":"Bulk create user agreements","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/user_agreements/bulk_create","href":"/api-reference/company-v0/company/bulk-create-user-agreements"}]},{"group":"Brand guidelines","pages":[{"title":"Show brand guidelines settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/brand_guidelines","href":"/api-reference/brand-guidelines/show-brand-guidelines-settings"},{"title":"Update brand guidelines settings with null values (clear operation)","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/brand_guidelines","href":"/api-reference/brand-guidelines/update-brand-guidelines-settings-with-null-values-clear-operation"}]},{"group":"Catch-ups","pages":[{"title":"List affiliate catch-up actions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/affiliate_catch_up_actions","href":"/api-reference/company-v0/affiliate-catch-up-actions/list-affiliate-catch-up-actions"},{"title":"List catch-up settings","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_up_settings","href":"/api-reference/company-v0/catch-up-settings/list-catch-up-settings"},{"title":"Activate a missing catch-up setting","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/catch_up_settings","href":"/api-reference/company-v0/catch-up-settings/activate-a-missing-catch-up-setting"},{"title":"Get a catch-up setting","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_up_settings/{id}","href":"/api-reference/company-v0/catch-up-settings/get-a-catch-up-setting"},{"title":"Update a catch-up setting","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/catch_up_settings/{id}","href":"/api-reference/company-v0/catch-up-settings/update-a-catch-up-setting"},{"title":"Delete a catch-up setting","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/catch_up_settings/{id}","href":"/api-reference/company-v0/catch-up-settings/delete-a-catch-up-setting"},{"title":"List catch-ups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_ups","href":"/api-reference/company-v0/catch-ups/list-catch-ups"},{"title":"Get the daily catch-up summary","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_ups/daily_summary","href":"/api-reference/company-v0/catch-ups/get-the-daily-catch-up-summary"},{"title":"List catch-up actions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_ups/{catch_up_id}/catch_up_actions","href":"/api-reference/company-v0/catch-ups/list-catch-up-actions"},{"title":"Get a catch-up action","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_ups/{catch_up_id}/catch_up_actions/{id}","href":"/api-reference/company-v0/catch-ups/get-a-catch-up-action"},{"title":"Execute a catch-up action","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/catch_ups/{catch_up_id}/catch_up_actions/{id}/execute","href":"/api-reference/company-v0/catch-ups/execute-a-catch-up-action"},{"title":"Mark a catch-up action as executed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/catch_ups/{catch_up_id}/catch_up_actions/{id}/mark_as_executed","href":"/api-reference/company-v0/catch-ups/mark-a-catch-up-action-as-executed"},{"title":"Mark a catch-up action as read","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/catch_ups/{catch_up_id}/catch_up_actions/{id}/mark_as_read","href":"/api-reference/company-v0/catch-ups/mark-a-catch-up-action-as-read"},{"title":"Snooze a catch-up action","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/catch_ups/{catch_up_id}/catch_up_actions/{id}/snooze","href":"/api-reference/company-v0/catch-ups/snooze-a-catch-up-action"},{"title":"Get a catch-up","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/catch_ups/{id}","href":"/api-reference/company-v0/catch-ups/get-a-catch-up"},{"title":"List custom catch-ups","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/custom_catch_ups","href":"/api-reference/company-v0/catch-ups/list-custom-catch-ups"},{"title":"Create a custom catch-up","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/custom_catch_ups","href":"/api-reference/company-v0/catch-ups/create-a-custom-catch-up"},{"title":"Update a custom catch-up","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/custom_catch_ups/{id}","href":"/api-reference/company-v0/catch-ups/update-a-custom-catch-up"},{"title":"Delete a custom catch-up","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/custom_catch_ups/{id}","href":"/api-reference/company-v0/catch-ups/delete-a-custom-catch-up"}]},{"group":"Company","pages":[{"title":"List reserved usernames","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/reserved_words","href":"/api-reference/companies/list-reserved-usernames"},{"title":"Block a username","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/reserved_words","href":"/api-reference/companies/block-a-username"},{"title":"Unblock a username","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/reserved_words/{id}","href":"/api-reference/companies/unblock-a-username"},{"title":"Update reward points settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/companies/{id}/reward_points","href":"/api-reference/companies/update-reward-points-settings"},{"title":"Set the bundle subscriptions setting for a company","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/set_bundle_subscriptions","href":"/api-reference/companies/set-the-bundle-subscriptions-setting-for-a-company"},{"title":"Set the shipping method for a company","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml post /api/companies/set_shipping","href":"/api-reference/companies/set-the-shipping-method-for-a-company"},{"title":"Set the tax class for a company","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml patch /api/companies/set_tax_class","href":"/api-reference/companies/set-the-tax-class-for-a-company"},{"title":"Set the tax option for a company","deprecated":null,"version":null,"openapi":"/api-reference/onboarding-v0.yaml patch /api/companies/set_tax_option","href":"/api-reference/companies/set-the-tax-option-for-a-company"},{"group":"Legacy (v0)","pages":[{"title":"Poll an agent access request","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/agent-access/v1/poll","href":"/api-reference/company-v0/company/poll-an-agent-access-request"},{"title":"List business types","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/business_types","href":"/api-reference/company-v0/business-types/list-business-types"},{"title":"Get the current company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/companies","href":"/api-reference/company-v0/companies/get-the-current-company"},{"title":"Get a company's payments status","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/companies/{id}/payments_status","href":"/api-reference/company-v0/companies/get-a-companys-payments-status"},{"title":"Get payments availability by country","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/companies/{id}/payments_status/availability_by_country","href":"/api-reference/company-v0/companies/get-payments-availability-by-country"},{"title":"Update companies","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/companies/{id}","href":"/api-reference/company-v0/company/update-companies"},{"title":"Set the email delivery provider for the current company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/email_provider","href":"/api-reference/company-v0/company/set-the-email-delivery-provider-for-the-current-company"},{"title":"Get plans","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/plans/{id}","href":"/api-reference/company-v0/company/get-plans"}]}]},{"group":"Fair Share","pages":[{"title":"Get Fair Share settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/fairshare/settings","href":"/api-reference/fairshare/get-fair-share-settings"},{"title":"Update Fair Share settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/fairshare/settings","href":"/api-reference/fairshare/update-fair-share-settings"}]},{"group":"Communications","pages":[{"title":"returns company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/company-email-settings","href":"/api-reference/company-email-settings/returns-company-email-settings"},{"title":"updates company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/company-email-settings/{id}","href":"/api-reference/company-email-settings/updates-company-email-settings"},{"title":"Company Email Settings company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company_email_settings","href":"/api-reference/company-email-settings/company-email-settings-company-email-settings"},{"title":"Get company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/company_email_settings/{id}","href":"/api-reference/company-email-settings/get-company-email-settings"},{"title":"Update company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/company_email_settings/{id}","href":"/api-reference/company-email-settings/update-company-email-settings"},{"title":"Replace company email settings","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v202506/company_email_settings/{id}","href":"/api-reference/company-email-settings/replace-company-email-settings"}]},{"group":"Messaging policy","pages":[{"title":"Get the Member messaging policy","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/member-policy","href":"/api-reference/messaging-member-policy/get-the-member-messaging-policy"},{"title":"Change the Member messaging policy","deprecated":null,"version":null,"openapi":"/api-reference/company-messaging-v2026-10.yaml put /api/company/v2026-10/messaging/member-policy","href":"/api-reference/messaging-member-policy/change-the-member-messaging-policy"}]},{"group":"AI bots","pages":[{"title":"List your bots","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots","href":"/api-reference/bots/list-your-bots"},{"title":"Create a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots","href":"/api-reference/bots/create-a-bot"},{"title":"Pause every bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/pause-all","href":"/api-reference/bots/pause-every-bot"},{"title":"Read a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{id}","href":"/api-reference/bots/read-a-bot"},{"title":"Change a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml patch /api/company/v2026-10/bots/{id}","href":"/api-reference/bots/change-a-bot"},{"title":"Delete a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{id}","href":"/api-reference/bots/delete-a-bot"},{"title":"Pause a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{id}/pause","href":"/api-reference/bots/pause-a-bot"},{"title":"Resume a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{id}/resume","href":"/api-reference/bots/resume-a-bot"},{"title":"Give a bot a new owner","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml put /api/company/v2026-10/bots/{id}/owner","href":"/api-reference/bots/give-a-bot-a-new-owner"},{"title":"List who could own a bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{id}/owner-candidates","href":"/api-reference/bots/list-who-could-own-a-bot"},{"title":"Read a bot's settings","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{id}/settings","href":"/api-reference/bots/read-a-bots-settings"},{"title":"Change a bot's settings","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml patch /api/company/v2026-10/bots/{id}/settings","href":"/api-reference/bots/change-a-bots-settings"},{"title":"List a bot's settings history","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/settings-versions","href":"/api-reference/bots/list-a-bots-settings-history"},{"title":"Read one settings version","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/settings-versions/{number}","href":"/api-reference/bots/read-one-settings-version"},{"title":"List a bot's capabilities","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/capabilities","href":"/api-reference/bots/list-a-bots-capabilities"},{"title":"List a bot's runs","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs","href":"/api-reference/bots/list-a-bots-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs/{id}","href":"/api-reference/bots/read-one-run"},{"title":"List a bot's stewards","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/stewards","href":"/api-reference/bots/list-a-bots-stewards"},{"title":"Add a steward","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/stewards","href":"/api-reference/bots/add-a-steward"},{"title":"Remove a steward","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/stewards/{admin_id}","href":"/api-reference/bots/remove-a-steward"},{"title":"Seat a bot in a conversation","deprecated":true,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/conversations","href":"/api-reference/bots/seat-a-bot-in-a-conversation"},{"title":"Open your direct conversation with a bot","deprecated":true,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{id}/direct-conversation","href":"/api-reference/bots/open-your-direct-conversation-with-a-bot"},{"title":"Take a bot out of a conversation","deprecated":true,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/conversations/{conversation_id}","href":"/api-reference/bots/take-a-bot-out-of-a-conversation"},{"title":"List a bot's approved hosts","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/http-hosts","href":"/api-reference/bots/list-a-bots-approved-hosts"},{"title":"Revoke an approved host","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/http-hosts/{id}","href":"/api-reference/bots/revoke-an-approved-host"},{"title":"List a bot's secrets","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/secrets","href":"/api-reference/bots/list-a-bots-secrets"},{"title":"Store a secret","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/secrets","href":"/api-reference/bots/store-a-secret"},{"title":"Delete a secret","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/secrets/{id}","href":"/api-reference/bots/delete-a-secret"},{"title":"List the kinds of action a bot can take","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-action-classes","href":"/api-reference/bots/list-the-kinds-of-action-a-bot-can-take"},{"title":"List the connectors bots can use","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-connectors","href":"/api-reference/bots/list-the-connectors-bots-can-use"},{"title":"Allow or disallow a connector for your company","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml put /api/company/v2026-10/bot-connectors/{key}","href":"/api-reference/bots/allow-or-disallow-a-connector-for-your-company"},{"title":"List bot connections","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-connections","href":"/api-reference/bots/list-bot-connections"},{"title":"Connect a remote MCP server or an app connector","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-connections","href":"/api-reference/bots/connect-a-remote-mcp-server-or-an-app-connector"},{"title":"Connection OAuth redirect target","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-connections/oauth/callback","href":"/api-reference/bots/connection-oauth-redirect-target"},{"title":"Finish a connection's OAuth","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-connections/oauth/complete","href":"/api-reference/bots/finish-a-connections-oauth"},{"title":"Switch a connection's tools","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml patch /api/company/v2026-10/bot-connections/{id}","href":"/api-reference/bots/switch-a-connections-tools"},{"title":"Disconnect","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bot-connections/{id}","href":"/api-reference/bots/disconnect"},{"title":"List a connection's tools again","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-connections/{id}/refresh-tools","href":"/api-reference/bots/list-a-connections-tools-again"},{"title":"Disable a connection","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-connections/{id}/disable","href":"/api-reference/bots/disable-a-connection"},{"title":"Enable a disabled connection","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-connections/{id}/enable","href":"/api-reference/bots/enable-a-disabled-connection"},{"title":"List the connections a bot can use","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/connections","href":"/api-reference/bots/list-the-connections-a-bot-can-use"},{"title":"List a bot's approvals","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/approvals","href":"/api-reference/bots/list-a-bots-approvals"},{"title":"Read an approval","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-approvals/{approval_id}","href":"/api-reference/bots/read-an-approval"},{"title":"Approve what a bot asked to do","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-approvals/{approval_id}/approve","href":"/api-reference/bots/approve-what-a-bot-asked-to-do"},{"title":"Decline what a bot asked to do","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bot-approvals/{approval_id}/decline","href":"/api-reference/bots/decline-what-a-bot-asked-to-do"},{"title":"List a bot's triggers","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/triggers","href":"/api-reference/bots/list-a-bots-triggers"},{"title":"Add a trigger","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/triggers","href":"/api-reference/bots/add-a-trigger"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/triggers/{id}","href":"/api-reference/bots/get-a-trigger"},{"title":"Change a trigger","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml patch /api/company/v2026-10/bots/{bot_id}/triggers/{id}","href":"/api-reference/bots/change-a-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/triggers/{id}","href":"/api-reference/bots/delete-a-trigger"},{"title":"Rotate a webhook trigger's secret","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/triggers/{id}/rotate-secret","href":"/api-reference/bots/rotate-a-webhook-triggers-secret"},{"title":"List event trigger topics","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bot-trigger-topics","href":"/api-reference/bots/list-event-trigger-topics"},{"title":"Read a bot's persona or memory","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/documents/{kind}","href":"/api-reference/bots/read-a-bots-persona-or-memory"},{"title":"Save a new version of a bot's persona or memory","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml put /api/company/v2026-10/bots/{bot_id}/documents/{kind}","href":"/api-reference/bots/save-a-new-version-of-a-bots-persona-or-memory"},{"title":"List a document's versions","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/documents/{kind}/versions","href":"/api-reference/bots/list-a-documents-versions"},{"title":"Revert a document to an earlier version","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/documents/{kind}/revert","href":"/api-reference/bots/revert-a-document-to-an-earlier-version"},{"title":"List a bot's canvas pages","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/canvas","href":"/api-reference/bots/list-a-bots-canvas-pages"},{"title":"Read a canvas page","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/canvas/pages/{slug}","href":"/api-reference/bots/read-a-canvas-page"},{"title":"Remove a canvas page","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/canvas/pages/{slug}","href":"/api-reference/bots/remove-a-canvas-page"},{"title":"Check one fluid_api call","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/api-check","href":"/api-reference/bots/check-one-fluid_api-call"},{"title":"Rename the bot","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/rename","href":"/api-reference/bots/rename-the-bot"},{"title":"Write a canvas page","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml put /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/canvas/pages/{slug}","href":"/api-reference/bots/write-a-canvas-page"},{"title":"Remove a canvas page in a run","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/canvas/pages/{slug}","href":"/api-reference/bots/remove-a-canvas-page-in-a-run"},{"title":"Skip or stop onboarding","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/onboarding","href":"/api-reference/bots/skip-or-stop-onboarding"},{"title":"Search the skill catalog","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/skills","href":"/api-reference/bots/search-the-skill-catalog"},{"title":"Add one of the bot's skills","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/skills","href":"/api-reference/bots/add-one-of-the-bots-skills"},{"title":"Read one skill","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/skill","href":"/api-reference/bots/read-one-skill"},{"title":"Drop one of the bot's skills","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/skills/{skill}","href":"/api-reference/bots/drop-one-of-the-bots-skills"},{"title":"Look up the Fluid API reference","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/api-docs","href":"/api-reference/bots/look-up-the-fluid-api-reference"},{"title":"Make one third-party HTTP request","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/http-request","href":"/api-reference/bots/make-one-third-party-http-request"},{"title":"Take one action in the run's web browser","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/browser/actions","href":"/api-reference/bots/take-one-action-in-the-runs-web-browser"},{"title":"Close the run's web browser","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml delete /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/browser","href":"/api-reference/bots/close-the-runs-web-browser"},{"title":"Run one connection tool","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/connections/{id}/call","href":"/api-reference/bots/run-one-connection-tool"},{"title":"Post a run's reply as its bot","deprecated":true,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/messages","href":"/api-reference/bots/post-a-runs-reply-as-its-bot"},{"title":"List a bot's recent actions","deprecated":null,"version":null,"openapi":"/api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/actions","href":"/api-reference/bots/list-a-bots-recent-actions"}]},{"group":"Bot templates","pages":[{"title":"List bot templates","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bot-templates","href":"/api-reference/bot-templates/list-bot-templates"},{"title":"Get a bot template","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bot-templates/{key}","href":"/api-reference/bot-templates/get-a-bot-template"},{"title":"Install a bot template","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml post /api/company/v2026-10/bot-templates/{key}/install","href":"/api-reference/bot-templates/install-a-bot-template"},{"title":"List a bot's playbooks","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/playbooks","href":"/api-reference/bot-templates/list-a-bots-playbooks"},{"title":"Change a playbook","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml patch /api/company/v2026-10/bots/{bot_id}/playbooks/{playbook_key}","href":"/api-reference/bot-templates/change-a-playbook"},{"title":"List a playbook's subjects","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/playbook-subjects","href":"/api-reference/bot-templates/list-a-playbooks-subjects"},{"title":"Ask Fluid to message a customer","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/outreach","href":"/api-reference/bot-templates/ask-fluid-to-message-a-customer"},{"title":"List a bot's touches","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/touches","href":"/api-reference/bot-templates/list-a-bots-touches"},{"title":"Get a touch","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/touches/{id}","href":"/api-reference/bot-templates/get-a-touch"},{"title":"Get a playbook's cohorts","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/cohorts","href":"/api-reference/bot-templates/get-a-playbooks-cohorts"},{"title":"Get a bot's send counts","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/send-stats","href":"/api-reference/bot-templates/get-a-bots-send-counts"},{"title":"Search public social posts","deprecated":null,"version":null,"openapi":"/api-reference/company-bot-templates-v2026-10.yaml post /api/company/v2026-10/bots/{bot_id}/runs/{run_id}/social-search","href":"/api-reference/bot-templates/search-public-social-posts"}]},{"group":"Languages and currencies","pages":[{"title":"List company languages","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/languages","href":"/api-reference/languages/list-company-languages"},{"title":"Configure company language","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/languages","href":"/api-reference/languages/configure-company-language"},{"title":"Remove company language","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/languages/{id}","href":"/api-reference/languages/remove-company-language"},{"group":"Legacy (v0)","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/countries","href":"/api-reference/company-v0/countries/list-countries"},{"title":"List supported currencies","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/currencies","href":"/api-reference/company-v0/currencies/list-supported-currencies"},{"title":"Convert an amount between currencies","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/currencies/convert","href":"/api-reference/company-v0/currencies/convert-an-amount-between-currencies"}]}]},{"group":"Roles","pages":[{"title":"Lists roles for a company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/roles","href":"/api-reference/company-v0/roles/lists-roles-for-a-company"},{"title":"Creates a new role for a company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/roles","href":"/api-reference/company-v0/roles/creates-a-new-role-for-a-company"},{"title":"Get current user's permissions","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/roles/my_permissions","href":"/api-reference/company-v0/roles/get-current-users-permissions"},{"title":"Get roles structure for the company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/roles/structure","href":"/api-reference/company-v0/roles/get-roles-structure-for-the-company"},{"title":"Returns a single role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/roles/{id}","href":"/api-reference/company-v0/roles/returns-a-single-role"},{"title":"Updates a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/company/roles/{id}","href":"/api-reference/company-v0/roles/updates-a-role"},{"title":"Deletes a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/roles/{id}","href":"/api-reference/company-v0/roles/deletes-a-role"},{"title":"Duplicates a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/roles/{id}/duplicate","href":"/api-reference/company-v0/roles/duplicates-a-role"},{"title":"Lists members assigned to a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/roles/{role_id}/members","href":"/api-reference/company-v0/roles/lists-members-assigned-to-a-role"},{"title":"Assigns users to a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/roles/{role_id}/members","href":"/api-reference/company-v0/roles/assigns-users-to-a-role"},{"title":"Removes a user from a role","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/company/roles/{role_id}/members/{id}","href":"/api-reference/company-v0/roles/removes-a-user-from-a-role"}]},{"group":"Social media","pages":[{"title":"Retrieves social media settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/social_media","href":"/api-reference/social-media/retrieves-social-media-settings"},{"title":"Updates social media settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/social_media","href":"/api-reference/social-media/updates-social-media-settings"}]},{"group":"Checkout settings","pages":[{"title":"Show a checkout settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/checkout","href":"/api-reference/checkout/show-a-checkout-settings"},{"title":"Update a checkout settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/checkout","href":"/api-reference/checkout/update-a-checkout-settings"}]},{"group":"Countries","pages":[{"title":"List company countries","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/company_countries","href":"/api-reference/countries/list-company-countries"},{"title":"Create a company country","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/company_countries","href":"/api-reference/countries/create-a-company-country"},{"title":"Get valid tax options for the company country","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/company_countries/tax_options","href":"/api-reference/countries/get-valid-tax-options-for-the-company-country"},{"title":"Bulk update company countries","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/company_countries/bulk_update","href":"/api-reference/countries/bulk-update-company-countries"},{"title":"Update a company country","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/company_countries/{id}","href":"/api-reference/countries/update-a-company-country"},{"title":"Delete a company country","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/company_countries/{id}","href":"/api-reference/countries/delete-a-company-country"}]},{"group":"Points","pages":[{"title":"Retrieve a list of points ledger entries for a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/customers/{customer_id}/points_ledgers","href":"/api-reference/points-ledgers/retrieve-a-list-of-points-ledger-entries-for-a-customer"},{"title":"Create a new points ledger entry","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/customers/{customer_id}/points_ledgers","href":"/api-reference/points-ledgers/create-a-new-points-ledger-entry"},{"title":"Points Ledgers points ledgers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/points_ledgers","href":"/api-reference/points-ledgers/points-ledgers-points-ledgers"},{"title":"Retrieve a list of points values for company currencies","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/points_values","href":"/api-reference/points-values/retrieve-a-list-of-points-values-for-company-currencies"},{"title":"Update a points value for a currency","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/points_values","href":"/api-reference/points-values/update-a-points-value-for-a-currency"},{"title":"Refresh points values","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/points_values/refresh","href":"/api-reference/points-values/refresh-points-values"}]},{"group":"Price types","pages":[{"title":"List a product's explicit catalog prices","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/products/{product_id}/prices","href":"/api-reference/products/list-a-products-explicit-catalog-prices"},{"title":"Show a bundle's per-price-type price grid","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/products/{product_id}/bundle-prices","href":"/api-reference/products/show-a-bundles-per-price-type-price-grid"},{"title":"Write a batch of bundle price cells","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/products/{product_id}/bundle-prices","href":"/api-reference/products/write-a-batch-of-bundle-price-cells"},{"title":"List explicit catalog prices for several products, paginated by variant","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/prices","href":"/api-reference/products/list-explicit-catalog-prices-for-several-products-paginated-by-variant"},{"title":"Write a batch of price-grid cells","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/prices","href":"/api-reference/products/write-a-batch-of-price-grid-cells"},{"title":"List company pricing tiers","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/pricing-tiers","href":"/api-reference/members/list-company-pricing-tiers"},{"title":"Create a custom price type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/pricing-tiers","href":"/api-reference/members/create-a-custom-price-type"},{"title":"Rename a price type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v2025-06/pricing-tiers/{id}","href":"/api-reference/members/rename-a-price-type"},{"title":"Archive a price type","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/pricing-tiers/{id}/archive","href":"/api-reference/members/archive-a-price-type"}]},{"group":"Ranks","pages":[{"title":"Lists all ranks for the current company","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v202506/ranks","href":"/api-reference/ranks/lists-all-ranks-for-the-current-company"},{"title":"Creates a rank for a company","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v202506/ranks","href":"/api-reference/ranks/creates-a-rank-for-a-company"},{"title":"Updates a rank","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml patch /api/v202506/ranks/{id}","href":"/api-reference/ranks/updates-a-rank"},{"title":"Soft-deletes a rank","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v202506/ranks/{id}","href":"/api-reference/ranks/soft-deletes-a-rank"},{"group":"Legacy (v0)","pages":[{"title":"List ranks","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/ranks","href":"/api-reference/company-v0/company/list-ranks"},{"title":"Create a rank","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/ranks","href":"/api-reference/company-v0/company/create-a-rank"},{"title":"Update ranks","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/company/ranks/{id}","href":"/api-reference/company-v0/company/update-ranks"}]}]},{"group":"Subscription plans","pages":[{"title":"List of subscription plans","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscription_plans","href":"/api-reference/company-v0/subscription-plans/list-of-subscription-plans"},{"title":"Create a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscription_plans","href":"/api-reference/company-v0/subscription-plans/create-a-subscription-plan"},{"title":"Show a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/subscription_plans/{id}","href":"/api-reference/company-v0/subscription-plans/show-a-subscription-plan"},{"title":"Update a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/subscription_plans/{id}","href":"/api-reference/company-v0/subscription-plans/update-a-subscription-plan"},{"title":"Update a subscription plan (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/subscription_plans/{id}","href":"/api-reference/company-v0/subscription-plans/update-a-subscription-plan-patch"},{"title":"Delete a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/subscription_plans/{id}","href":"/api-reference/company-v0/subscription-plans/delete-a-subscription-plan"},{"title":"Delete a product from subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/subscription_plans/{id}/remove_product","href":"/api-reference/company-v0/subscription-plans/delete-a-product-from-subscription-plan"}]},{"group":"Taxes","pages":[{"title":"List the merchant Avalara account slots","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/avalara_account","href":"/api-reference/taxes/list-the-merchant-avalara-account-slots"},{"title":"Create or update a merchant Avalara account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/avalara_account","href":"/api-reference/taxes/create-or-update-a-merchant-avalara-account-slot"},{"title":"Remove a merchant Avalara account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/avalara_account","href":"/api-reference/taxes/remove-a-merchant-avalara-account-slot"},{"title":"Test a merchant Avalara connection","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/avalara_account/test_connection","href":"/api-reference/taxes/test-a-merchant-avalara-connection"},{"title":"Verify and save a merchant Avalara account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/avalara_account/verified","href":"/api-reference/taxes/verify-and-save-a-merchant-avalara-account-slot"},{"title":"Verify and save a merchant Sovos account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/sovos_account/verified","href":"/api-reference/taxes/verify-and-save-a-merchant-sovos-account-slot"},{"title":"List the merchant Sovos account slots","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/sovos_account","href":"/api-reference/taxes/list-the-merchant-sovos-account-slots"},{"title":"Create or update a merchant Sovos account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/sovos_account","href":"/api-reference/taxes/create-or-update-a-merchant-sovos-account-slot"},{"title":"Remove a merchant Sovos account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/sovos_account","href":"/api-reference/taxes/remove-a-merchant-sovos-account-slot"},{"title":"Read whether the Sovos account form is released","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/sovos_account/capability","href":"/api-reference/taxes/read-whether-the-sovos-account-form-is-released"},{"title":"Test a stored Sovos account slot","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/sovos_account/test_connection","href":"/api-reference/taxes/test-a-stored-sovos-account-slot"},{"title":"Show the merchant Avalara tax settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/avalara_setting","href":"/api-reference/taxes/show-the-merchant-avalara-tax-settings"},{"title":"Update the merchant Avalara tax settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/avalara_setting","href":"/api-reference/taxes/update-the-merchant-avalara-tax-settings"},{"group":"Legacy (v0)","pages":[{"title":"Get tax categories","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/tax_categories","href":"/api-reference/company-v0/tax-categories/get-tax-categories"},{"title":"Retrieve a tax category","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/tax_categories/{id}","href":"/api-reference/company-v0/tax-categories/retrieve-a-tax-category"}]}]},{"group":"Warehouses","pages":[{"title":"List warehouses","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/warehouses","href":"/api-reference/warehouses/list-warehouses"},{"title":"Create a warehouse","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/warehouses","href":"/api-reference/warehouses/create-a-warehouse"},{"title":"Show a warehouse","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/warehouses/{id}","href":"/api-reference/warehouses/show-a-warehouse"},{"title":"Update a warehouse","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/warehouses/{id}","href":"/api-reference/warehouses/update-a-warehouse"},{"title":"Delete a warehouse","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/warehouses/{id}","href":"/api-reference/warehouses/delete-a-warehouse"},{"title":"Append metadata field","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/warehouses/{id}/append_metadata","href":"/api-reference/warehouses/append-metadata-field"},{"title":"Assign warehouse to country","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/warehouses/{id}/assign_to_country","href":"/api-reference/warehouses/assign-warehouse-to-country"}]},{"group":"Subscription Pro","pages":[{"title":"Show the company's Subscription Pro settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/settings","href":"/api-reference/subscription-pro/show-the-companys-subscription-pro-settings"},{"title":"Change the company's Subscription Pro settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/subscription_pro/settings","href":"/api-reference/subscription-pro/change-the-companys-subscription-pro-settings"},{"title":"Show where the company stands in setting up SMS reminders","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/sms_onboarding","href":"/api-reference/subscription-pro/show-where-the-company-stands-in-setting-up-sms-reminders"},{"title":"Turn on SMS reminders","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/sms_onboarding","href":"/api-reference/subscription-pro/turn-on-sms-reminders"},{"title":"Answer whether the business is publicly traded","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/subscription_pro/sms_onboarding","href":"/api-reference/subscription-pro/answer-whether-the-business-is-publicly-traded"},{"title":"Send a rejected verification to Twilio again","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/sms_onboarding/resubmit","href":"/api-reference/subscription-pro/send-a-rejected-verification-to-twilio-again"},{"title":"Preview what a blackout calendar would move","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/blackout_preview","href":"/api-reference/subscription-pro/preview-what-a-blackout-calendar-would-move"},{"title":"Report the company's milestone items","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/milestone_report","href":"/api-reference/subscription-pro/report-the-companys-milestone-items"},{"title":"Export the company's milestone items as a CSV","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/milestone_report/export_csv","href":"/api-reference/subscription-pro/export-the-companys-milestone-items-as-a-csv"},{"title":"List the company's milestone rules","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/milestone_rules","href":"/api-reference/subscription-pro/list-the-companys-milestone-rules"},{"title":"Add a draft milestone rule","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/milestone_rules","href":"/api-reference/subscription-pro/add-a-draft-milestone-rule"},{"title":"Publish a milestone rule","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/milestone_rules/{id}/publish","href":"/api-reference/subscription-pro/publish-a-milestone-rule"},{"title":"Archive a milestone rule","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/milestone_rules/{id}/archive","href":"/api-reference/subscription-pro/archive-a-milestone-rule"},{"title":"Show the company's cancel flow","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/retention_flow","href":"/api-reference/subscription-pro/show-the-companys-cancel-flow"},{"title":"Publish the next version of the company's cancel flow","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/retention_flow","href":"/api-reference/subscription-pro/publish-the-next-version-of-the-companys-cancel-flow"},{"title":"List the company's tenure programs","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/tenure_programs","href":"/api-reference/subscription-pro/list-the-companys-tenure-programs"},{"title":"Start a tenure program","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/tenure_programs","href":"/api-reference/subscription-pro/start-a-tenure-program"},{"title":"Show a tenure program","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/tenure_programs/{id}","href":"/api-reference/subscription-pro/show-a-tenure-program"},{"title":"Preview a tenure publication","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/tenure_programs/{id}/versions/preview","href":"/api-reference/subscription-pro/preview-a-tenure-publication"},{"title":"Publish a tenure program version","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/tenure_programs/{id}/versions","href":"/api-reference/subscription-pro/publish-a-tenure-program-version"},{"title":"Archive a tenure program","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/tenure_programs/{id}/archive","href":"/api-reference/subscription-pro/archive-a-tenure-program"},{"title":"List the company's cancel flow experiments","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/retention_experiments","href":"/api-reference/subscription-pro/list-the-companys-cancel-flow-experiments"},{"title":"Start a cancel flow experiment","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/retention_experiments","href":"/api-reference/subscription-pro/start-a-cancel-flow-experiment"},{"title":"Stop a cancel flow experiment","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/subscription_pro/retention_experiments/{id}/stop","href":"/api-reference/subscription-pro/stop-a-cancel-flow-experiment"},{"title":"Show the company's cancel flow report","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/subscription_pro/retention_report","href":"/api-reference/subscription-pro/show-the-companys-cancel-flow-report"}]},{"group":"Billing","pages":[{"title":"Show the company's billing page","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing","href":"/api-reference/billing/show-the-companys-billing-page"},{"title":"Set where the company's invoices are sent","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/billing","href":"/api-reference/billing/set-where-the-companys-invoices-are-sent"},{"title":"Show the company's billing standing","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/standing","href":"/api-reference/billing/show-the-companys-billing-standing"},{"title":"List the company's Stripe documents","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/documents","href":"/api-reference/billing/list-the-companys-stripe-documents"},{"title":"Get the Stripe link of a document","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/documents/{id}/link","href":"/api-reference/billing/get-the-stripe-link-of-a-document"},{"title":"List the company's payments","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/payments","href":"/api-reference/billing/list-the-companys-payments"},{"title":"Get the Stripe invoice link of a payment","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/payments/{id}/invoice","href":"/api-reference/billing/get-the-stripe-invoice-link-of-a-payment"},{"title":"Show the company's spend limits","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/usage-controls","href":"/api-reference/billing/show-the-companys-spend-limits"},{"title":"Set the company's spend limits","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/billing/usage-controls","href":"/api-reference/billing/set-the-companys-spend-limits"},{"title":"Show the company's plan and credits","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits","href":"/api-reference/billing/show-the-companys-plan-and-credits"},{"title":"Move the company onto another plan","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/billing/credits","href":"/api-reference/billing/move-the-company-onto-another-plan"},{"title":"List the changes to the company's credit balance","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits/movements","href":"/api-reference/billing/list-the-changes-to-the-companys-credit-balance"},{"title":"Price a purchase of credits","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits/quote","href":"/api-reference/billing/price-a-purchase-of-credits"},{"title":"List the company's credit purchases","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits/purchases","href":"/api-reference/billing/list-the-companys-credit-purchases"},{"title":"Buy credits with the saved card or bank account","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/billing/credits/purchases","href":"/api-reference/billing/buy-credits-with-the-saved-card-or-bank-account"},{"title":"Get the Stripe invoice link of a credit purchase","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits/purchases/{id}/invoice","href":"/api-reference/billing/get-the-stripe-invoice-link-of-a-credit-purchase"},{"title":"Get what the browser needs to confirm a waiting card purchase","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/credits/purchases/{id}/authentication","href":"/api-reference/billing/get-what-the-browser-needs-to-confirm-a-waiting-card-purchase"},{"title":"Give up a waiting card purchase","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/billing/credits/purchases/{id}/authentication","href":"/api-reference/billing/give-up-a-waiting-card-purchase"},{"title":"Pay the overdrawn credit balance now","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/billing/credits/pay-now","href":"/api-reference/billing/pay-the-overdrawn-credit-balance-now"},{"title":"Switch collections onto an authorized bank account or saved card","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml patch /api/settings/billing/instrument","href":"/api-reference/billing/switch-collections-onto-an-authorized-bank-account-or-saved-card"},{"title":"Cancel an unfinished bank setup","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml delete /api/settings/billing/instrument-setup","href":"/api-reference/billing/cancel-an-unfinished-bank-setup"},{"title":"Show company bank-account setup state","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/billing/instrument-setup","href":"/api-reference/billing/show-company-bank-account-setup-state"},{"title":"Start company bank-account setup","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/billing/instrument-setup","href":"/api-reference/billing/start-company-bank-account-setup"},{"title":"Finish a setup Stripe confirmed","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml post /api/settings/billing/instrument-setup/confirm","href":"/api-reference/billing/finish-a-setup-stripe-confirmed"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml post /api/company/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Bulk delete webhooks","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml delete /api/company/webhooks/bulk_delete","href":"/api-reference/webhooks/bulk-delete-webhooks"},{"title":"List webhook resources","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/webhooks/resources","href":"/api-reference/webhooks-resources/list-webhook-resources"},{"title":"Show a webhook","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/webhooks/{id}","href":"/api-reference/webhooks/show-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml put /api/company/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml delete /api/company/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List webhook schemas","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/webhooks/schemas","href":"/api-reference/webhook-schemas/list-webhook-schemas"},{"title":"Show a webhook schema","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/webhooks/schemas/{event_identifier}","href":"/api-reference/webhook-schemas/show-a-webhook-schema"},{"title":"Get webhook events for a resource","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/company/webhooks/resources/{resource_name}","href":"/api-reference/webhooks/get-webhook-events-for-a-resource"},{"group":"Legacy (v0)","pages":[{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/webhook_events","href":"/api-reference/company-v0/webhook-events/list-webhook-events"},{"title":"Show webhook event","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/webhook_events/{id}","href":"/api-reference/company-v0/webhook-events/show-webhook-event"}]}]},{"group":"Callbacks","pages":[{"title":"List callback definitions","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/callback/definitions","href":"/api-reference/callback-definitions/list-callback-definitions"},{"title":"List callback registrations","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/callback/registrations","href":"/api-reference/callback-registrations/list-callback-registrations"},{"title":"Create a callback registration","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml post /api/callback/registrations","href":"/api-reference/callback-registrations/create-a-callback-registration"},{"title":"Show a callback registration","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/callback/registrations/{uuid}","href":"/api-reference/callback-registrations/show-a-callback-registration"},{"title":"Update a callback registration","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml put /api/callback/registrations/{uuid}","href":"/api-reference/callback-registrations/update-a-callback-registration"},{"title":"Delete a callback registration","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml delete /api/callback/registrations/{uuid}","href":"/api-reference/callback-registrations/delete-a-callback-registration"},{"title":"List callback schemas","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/callback/schemas","href":"/api-reference/callback-schemas/list-callback-schemas"},{"title":"Show a callback schema","deprecated":null,"version":null,"openapi":"/api-reference/webhooks-v0.yaml get /api/callback/schemas/{definition_name}","href":"/api-reference/callback-schemas/show-a-callback-schema"}]},{"group":"Databases","pages":[{"title":"Get reporting database settings","deprecated":null,"version":null,"openapi":"/api-reference/reporting-databases-v2026-04.yaml get /api/v202604/reporting_databases/settings","href":"/api-reference/reporting-database-settings/get-reporting-database-settings"},{"title":"Update reporting database sync settings","deprecated":null,"version":null,"openapi":"/api-reference/reporting-databases-v2026-04.yaml patch /api/v202604/reporting_databases/settings","href":"/api-reference/reporting-database-settings/update-reporting-database-sync-settings"},{"title":"Request a reporting database sync","deprecated":null,"version":null,"openapi":"/api-reference/reporting-databases-v2026-04.yaml post /api/v202604/reporting_databases/sync","href":"/api-reference/reporting-database-settings/request-a-reporting-database-sync"}]},{"group":"Domains","pages":[{"title":"Show external payment redirect hosts","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/payment_redirect_hosts","href":"/api-reference/domains/show-external-payment-redirect-hosts"},{"title":"Replace external payment redirect hosts","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/payment_redirect_hosts","href":"/api-reference/domains/replace-external-payment-redirect-hosts"},{"group":"Legacy (v0)","pages":[{"title":"Get the company subdomain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/company/subdomain","href":"/api-reference/company-v0/company/get-the-company-subdomain"},{"title":"Lists domains","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/domains","href":"/api-reference/company-v0/domains/lists-domains"},{"title":"Create domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/domains","href":"/api-reference/company-v0/domains/create-domain"},{"title":"Lists subdomains","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/domains/{domain_id}/subdomains","href":"/api-reference/company-v0/subdomains/lists-subdomains"},{"title":"Create subdomain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/domains/{domain_id}/subdomains","href":"/api-reference/company-v0/subdomains/create-subdomain"},{"title":"Retrieves a domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/domains/{id}","href":"/api-reference/company-v0/domains/retrieves-a-domain"},{"title":"Updates a domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/domains/{id}","href":"/api-reference/company-v0/domains/updates-a-domain"},{"title":"Deletes a domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/domains/{id}","href":"/api-reference/company-v0/domains/deletes-a-domain"},{"title":"Check CNAME propagation","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/domains/{id}/check_cname_propagation","href":"/api-reference/company-v0/domains/check-cname-propagation"},{"title":"Confirm CNAME for domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/domains/{id}/confirm_cname_for_domain","href":"/api-reference/company-v0/domains/confirm-cname-for-domain"},{"title":"Check and advance a domain's setup","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/domains/{id}/reconcile","href":"/api-reference/company-v0/domains/check-and-advance-a-domains-setup"},{"title":"Verify domain","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml patch /api/domains/{id}/verify_domain","href":"/api-reference/company-v0/domains/verify-domain"}]}]},{"group":"Drop zones","pages":[{"title":"An array of available drop zones","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/drop_zones","href":"/api-reference/company-v0/drop-zones/an-array-of-available-drop-zones"},{"title":"Create a drop zone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/drop_zones","href":"/api-reference/company-v0/drop-zones/create-a-drop-zone"},{"title":"Get drop zone constants","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/drop_zones/constants","href":"/api-reference/company-v0/drop-zones/get-drop-zone-constants"},{"title":"Get a signed drop zone context token","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/drop_zones/context_token","href":"/api-reference/company-v0/drop-zones/get-a-signed-drop-zone-context-token"},{"title":"Get a drop zone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/drop_zones/{uuid}","href":"/api-reference/company-v0/drop-zones/get-a-drop-zone"},{"title":"Update a drop zone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/drop_zones/{uuid}","href":"/api-reference/company-v0/drop-zones/update-a-drop-zone"},{"title":"Delete a drop zone","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/drop_zones/{uuid}","href":"/api-reference/company-v0/drop-zones/delete-a-drop-zone"}]},{"group":"Global embeds","pages":[{"title":"List global embeds","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/global_embeds","href":"/api-reference/company-v0/globalembeds/list-global-embeds"},{"title":"Create a global embed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/global_embeds","href":"/api-reference/company-v0/globalembeds/create-a-global-embed"},{"title":"Get a global embed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml get /api/global_embeds/{id}","href":"/api-reference/company-v0/globalembeds/get-a-global-embed"},{"title":"Update a global embed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml put /api/global_embeds/{id}","href":"/api-reference/company-v0/globalembeds/update-a-global-embed"},{"title":"Delete a global embed","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/global_embeds/{id}","href":"/api-reference/company-v0/globalembeds/delete-a-global-embed"}]},{"group":"Pro features","pages":[{"title":"Show pro features settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml get /api/settings/pro_features","href":"/api-reference/pro-features/show-pro-features-settings"},{"title":"Update pro features settings","deprecated":null,"version":null,"openapi":"/api-reference/settings-v0.yaml put /api/settings/pro_features","href":"/api-reference/pro-features/update-pro-features-settings"}]},{"group":"Devices","pages":[{"title":"Create or refresh a device","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/devices/create_or_refresh","href":"/api-reference/company-v0/devices/create-or-refresh-a-device"},{"title":"Delete device by ID","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml delete /api/devices/{id}","href":"/api-reference/company-v0/devices/delete-device-by-id"}]}]},{"group":"FairShare SDK","pages":[{"group":"Settings and session","pages":[{"title":"Retrieve affiliate information","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/affiliates/lookup","href":"/api-reference/affiliate/retrieve-affiliate-information"},{"title":"Start a new fingerprint","deprecated":true,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/browser/fingerprint","href":"/api-reference/fingerprint/start-a-new-fingerprint"},{"title":"Start a new session","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/session","href":"/api-reference/session/start-a-new-session"},{"title":"Retrieve page settings","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/settings","href":"/api-reference/settings/retrieve-page-settings"}]},{"group":"Carts","pages":[{"title":"Update cart items prices","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/carts/{cart_token}/update_cart_items_prices","href":"/api-reference/commerce/update-cart-items-prices"},{"title":"Recalculate the cart's external discounts","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/carts/{cart_token}/refresh-discounts","href":"/api-reference/commerce/recalculate-the-carts-external-discounts"},{"title":"Creates a cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts","href":"/api-reference/carts/creates-a-cart"},{"title":"Retrieves a cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/commerce/carts/{cart_token}","href":"/api-reference/carts/retrieves-a-cart"},{"title":"Updates a cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}","href":"/api-reference/carts/updates-a-cart"},{"title":"Updates a cart (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml put /api/public/v2025-06/commerce/carts/{cart_token}","href":"/api-reference/carts/updates-a-cart-put"},{"title":"Updates cart address","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/address","href":"/api-reference/carts/updates-cart-address"},{"title":"Retrieves cart company information","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/commerce/carts/{cart_token}/cart_info","href":"/api-reference/carts/retrieves-cart-company-information"},{"title":"Updates the language of a cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}/change_language","href":"/api-reference/carts/updates-the-language-of-a-cart"},{"title":"Completes cart checkout","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/checkout","href":"/api-reference/carts/completes-cart-checkout"},{"title":"Confirm magic link for cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/confirm_magic_link","href":"/api-reference/carts/confirm-magic-link-for-cart"},{"title":"Apply a promo code to the cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/discount","href":"/api-reference/carts/apply-a-promo-code-to-the-cart"},{"title":"Retrieves enroll for cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/commerce/carts/{cart_token}/enroll","href":"/api-reference/carts/retrieves-enroll-for-cart"},{"title":"Add enrollment to existing cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/enrollment","href":"/api-reference/carts/add-enrollment-to-existing-cart"},{"title":"Flag a Public SDK cart as enrollment eligible","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}/enrollment","href":"/api-reference/carts/flag-a-public-sdk-cart-as-enrollment-eligible"},{"title":"Adds items to cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/items","href":"/api-reference/carts/adds-items-to-cart"},{"title":"Removes item from cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml delete /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}","href":"/api-reference/carts/removes-item-from-cart"},{"title":"Subscribes a cart item","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/subscribe","href":"/api-reference/carts/subscribes-a-cart-item"},{"title":"Updates subscribe:false to cart item","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml delete /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/subscribe","href":"/api-reference/carts/updates-subscribe:false-to-cart-item"},{"title":"Updates a cart item's variant","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/variant","href":"/api-reference/carts/updates-a-cart-items-variant"},{"title":"Removes rep_buyer and customer for the cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml delete /api/public/v2025-06/commerce/carts/{cart_token}/logout","href":"/api-reference/carts/removes-rep_buyer-and-customer-for-the-cart"},{"title":"Create magic link for cart","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/magic_link","href":"/api-reference/carts/create-magic-link-for-cart"},{"title":"Sets cart payment method","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/payment_methods/{type}","href":"/api-reference/carts/sets-cart-payment-method"},{"title":"Sets cart shipping method","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/shipping_method","href":"/api-reference/carts/sets-cart-shipping-method"},{"title":"Syncs cart with authenticated customer","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/commerce/carts/{cart_token}/sync_customer","href":"/api-reference/carts/syncs-cart-with-authenticated-customer"},{"title":"Updates the country of a cart, also updates the currency code","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}/update_country","href":"/api-reference/carts/updates-the-country-of-a-cart-also-updates-the-currency-code"},{"title":"Retrieves an order with points redemption","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/orders/{token}","href":"/api-reference/orders/retrieves-an-order-with-points-redemption"},{"title":"Client Token client token","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/v202506/carts/{cart_token}/braintree/client_token","href":"/api-reference/carts/client-token-client-token"},{"title":"Create Payment create payment","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/braintree/create_payment","href":"/api-reference/carts/create-payment-create-payment"},{"title":"Check Order Status check order status","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/v202506/carts/{cart_token}/check_order_status","href":"/api-reference/carts/check-order-status-check-order-status"},{"title":"Ipn ipn","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/citcon_upi/ipn","href":"/api-reference/carts/ipn-ipn"},{"title":"Create dlocal","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/dlocal/{webhook_type}","href":"/api-reference/carts/create-dlocal"},{"title":"Create dlocal refund notification","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/refunds/dlocal","href":"/api-reference/carts/create-dlocal-refund-notification"},{"title":"Create dlocal renewal notification","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/subscriptions/renewals/dlocal","href":"/api-reference/subscriptions/create-dlocal-renewal-notification"},{"title":"Shipping Address Change shipping address change","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/paypal/shipping_address_change","href":"/api-reference/carts/shipping-address-change-shipping-address-change"},{"title":"Shipping Method Change shipping method change","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/paypal/shipping_method_change","href":"/api-reference/carts/shipping-method-change-shipping-method-change"},{"title":"Venmo Shipping Callback shipping callback","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/paypal/venmo_shipping_callback","href":"/api-reference/carts/venmo-shipping-callback-shipping-callback"},{"title":"Create ppro","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/ppro/{webhook_type}","href":"/api-reference/carts/create-ppro"}]},{"group":"Checkout events","pages":[{"title":"Record a checkout starting","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/events/checkout/started","href":"/api-reference/checkout/record-a-checkout-starting"}]},{"group":"Payments","pages":[{"title":"Creates a Klarna payment session","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/klarna/create_session","href":"/api-reference/payment/creates-a-klarna-payment-session"},{"title":"Updates a Klarna session","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/klarna/update_session","href":"/api-reference/payment/updates-a-klarna-session"},{"title":"Authorize order in paypal","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/paypal/authorize_order","href":"/api-reference/paypal/authorize-order-in-paypal"},{"title":"Create order in paypal","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/v202506/carts/{cart_token}/paypal/create_order","href":"/api-reference/paypal/create-order-in-paypal"}]},{"group":"Products and enrollments","pages":[{"title":"Get enrollment pack by slug","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/enrollment_packs/{slug}","href":"/api-reference/enrollment-packs/get-enrollment-pack-by-slug"},{"title":"Get product by slug in a foreign local includes the correct variants","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/products/{slug}","href":"/api-reference/product/get-product-by-slug-in-a-foreign-local-includes-the-correct-variants"}]},{"group":"Media and playlists","pages":[{"title":"Create video analytics event","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/events/media/video_analytics","href":"/api-reference/media/create-video-analytics-event"},{"title":"Get media by slug (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/media","href":"/api-reference/media/get-media-by-slug-deprecated"},{"title":"Get media by slug","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/media/{slug}","href":"/api-reference/media/get-media-by-slug"},{"title":"Get playlist by slug (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/playlists","href":"/api-reference/playlist/get-playlist-by-slug-deprecated"},{"title":"Get playlist by slug","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/playlists/{slug}","href":"/api-reference/playlist/get-playlist-by-slug"}]},{"group":"Forms and leads","pages":[{"title":"Save a new lead capture","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/events/leads/capture","href":"/api-reference/events/save-a-new-lead-capture"},{"title":"Save a new page visit","deprecated":true,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/events/pages/visit","href":"/api-reference/events/save-a-new-page-visit"},{"title":"Save a new url visit","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/events/urls/visit","href":"/api-reference/events/save-a-new-url-visit"},{"title":"Get form by public token","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/forms/{token}","href":"/api-reference/forms/get-form-by-public-token"},{"title":"Submit a form response","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/forms/{token}/respond","href":"/api-reference/forms/submit-a-form-response"},{"title":"Verify form password","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/forms/{token}/verify_password","href":"/api-reference/forms/verify-form-password"}]},{"group":"Widgets","pages":[{"title":"Retrieve banner widget","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/widgets/banners","href":"/api-reference/widgets/retrieve-banner-widget"},{"title":"Retrieve cart widget","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/widgets/carts","href":"/api-reference/widgets/retrieve-cart-widget"},{"title":"Retrieve chat widget","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/widgets/chats","href":"/api-reference/widgets/retrieve-chat-widget"},{"title":"Retrieve popup widget","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml post /api/public/v2025-06/widgets/popups","href":"/api-reference/widgets/retrieve-popup-widget"}]},{"group":"Drop zones","pages":[{"title":"An array of available checkout, order confirmation, and cart drop zones (public)","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/drop_zones","href":"/api-reference/public-drop-zones/an-array-of-available-checkout-order-confirmation-and-cart-drop-zones-public"}]},{"group":"Themes","pages":[{"title":"List root themes","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/root_themes","href":"/api-reference/root-themes/list-root-themes"},{"title":"Get root theme by ID","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/root_themes/{id}","href":"/api-reference/root-themes/get-root-theme-by-id"}]},{"group":"Health","pages":[{"title":"Health health","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/health","href":"/api-reference/public/health-health"},{"title":"Db Port db port","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/health/db_port","href":"/api-reference/public/db-port-db-port"},{"title":"Homepage Render homepage render","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/health/homepage_render","href":"/api-reference/public/homepage-render-homepage-render"},{"title":"Countries countries","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/leaderboards/countries","href":"/api-reference/public/countries-countries"},{"title":"Get apple pay domain","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/apple_pay_domain/{hostname}","href":"/api-reference/public/get-apple-pay-domain"},{"title":"Update Volumes update volumes","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml patch /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/update_volumes","href":"/api-reference/public/update-volumes-update-volumes"},{"title":"Realtime realtime","deprecated":null,"version":null,"openapi":"/api-reference/public-v2025-06.yaml get /api/public/v2025-06/health/realtime","href":"/api-reference/public/realtime-realtime"}]}]},{"group":"Droplets","pages":[{"group":"Droplets","pages":[{"title":"List and search droplets","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets","href":"/api-reference/droplets/list-and-search-droplets"},{"title":"Create a droplet for your company","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplets","href":"/api-reference/droplets/create-a-droplet-for-your-company"},{"title":"Read a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets/{uuid}","href":"/api-reference/droplets/read-a-droplet"},{"title":"Update a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml patch /api/company/v2026-10/droplets/{uuid}","href":"/api-reference/droplets/update-a-droplet"},{"title":"Delete a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml delete /api/company/v2026-10/droplets/{uuid}","href":"/api-reference/droplets/delete-a-droplet"},{"title":"Check a droplet's health","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets/{uuid}/health","href":"/api-reference/droplets/check-a-droplets-health"},{"title":"Read a droplet's status","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets/{uuid}/status","href":"/api-reference/droplets/read-a-droplets-status"},{"title":"Rotate a droplet's webhook secret","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplets/{uuid}/webhook-secret-rotations","href":"/api-reference/droplets/rotate-a-droplets-webhook-secret"},{"title":"Ask Fluid to publish a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplets/{droplet_uuid}/publish-request","href":"/api-reference/droplets/ask-fluid-to-publish-a-droplet"},{"title":"Withdraw a request to publish a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml delete /api/company/v2026-10/droplets/{droplet_uuid}/publish-request","href":"/api-reference/droplets/withdraw-a-request-to-publish-a-droplet"},{"title":"Read a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplet-installations/{uuid}","href":"/api-reference/droplets/read-a-droplet-installation"},{"title":"Change a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml patch /api/company/v2026-10/droplet-installations/{uuid}","href":"/api-reference/droplets/change-a-droplet-installation"},{"title":"Uninstall a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml delete /api/company/v2026-10/droplet-installations/{uuid}","href":"/api-reference/droplets/uninstall-a-droplet"},{"title":"Roll an installation back to an earlier version","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplet-installations/{uuid}/rollback","href":"/api-reference/droplets/roll-an-installation-back-to-an-earlier-version"},{"title":"Retry a failed reconcile","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplet-installations/{uuid}/reconcile","href":"/api-reference/droplets/retry-a-failed-reconcile"},{"title":"Read a droplet installation's status","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplet-installations/{uuid}/status","href":"/api-reference/droplets/read-a-droplet-installations-status"},{"title":"List droplet categories","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplet-categories","href":"/api-reference/droplets/list-droplet-categories"}]},{"group":"Installations","pages":[{"title":"List the companies that installed your droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets/{droplet_uuid}/installations","href":"/api-reference/droplets/list-the-companies-that-installed-your-droplet"},{"title":"Install a droplet","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml post /api/company/v2026-10/droplets/{droplet_uuid}/installations","href":"/api-reference/droplets/install-a-droplet"},{"title":"List installed droplets","deprecated":null,"version":null,"openapi":"/api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplet-installations","href":"/api-reference/droplets/list-installed-droplets"},{"title":"Exchange an install token for installation credentials","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml post /api/droplet_installations/exchange","href":"/api-reference/droplet-installations/exchange-an-install-token-for-installation-credentials"}]},{"group":"Connect","pages":[{"title":"List Connect integrations","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations","href":"/api-reference/connect/list-connect-integrations"},{"title":"Read a Connect integration's status","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/status","href":"/api-reference/connect/read-a-connect-integrations-status"},{"title":"Read provider order totals","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/provider/orders/totals","href":"/api-reference/connect/read-provider-order-totals"},{"title":"Read provider customer totals","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/provider/customers/totals","href":"/api-reference/connect/read-provider-customer-totals"},{"title":"Reconcile provider order ids","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/provider/orders/reconciliation","href":"/api-reference/connect/reconcile-provider-order-ids"},{"title":"Reconcile provider customer ids","deprecated":null,"version":null,"openapi":"/api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/provider/customers/reconciliation","href":"/api-reference/connect/reconcile-provider-customer-ids"}]},{"group":"Legacy (v0)","pages":[{"title":"Returns a list of all droplet categories","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplet_categories","href":"/api-reference/droplet-categories/returns-a-list-of-all-droplet-categories"},{"title":"List droplet installations","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplet_installations","href":"/api-reference/droplet-installations/list-droplet-installations"},{"title":"Create a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml post /api/droplet_installations","href":"/api-reference/droplet_installations/create-a-droplet-installation"},{"title":"Show a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplet_installations/{uuid}","href":"/api-reference/droplet-installations/show-a-droplet-installation"},{"title":"Update a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml put /api/droplet_installations/{uuid}","href":"/api-reference/droplet-installations/update-a-droplet-installation"},{"title":"Delete a droplet installation","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml delete /api/droplet_installations/{uuid}","href":"/api-reference/droplet-installations/delete-a-droplet-installation"},{"title":"An array of available droplets","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplets","href":"/api-reference/droplets/an-array-of-available-droplets"},{"title":"Create a droplet","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml post /api/droplets","href":"/api-reference/droplets/create-a-droplet"},{"title":"List your company's own droplets","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplets/company_droplets","href":"/api-reference/droplets/list-your-companys-own-droplets"},{"title":"shows a droplet","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplets/{uuid}","href":"/api-reference/droplets/shows-a-droplet"},{"title":"updates a droplet","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml put /api/droplets/{uuid}","href":"/api-reference/droplets/updates-a-droplet"},{"title":"deletes a droplet","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml delete /api/droplets/{uuid}","href":"/api-reference/droplets/deletes-a-droplet"},{"title":"returns an array of companies using a droplet","deprecated":null,"version":null,"openapi":"/api-reference/integrations-v0.yaml get /api/droplets/{uuid}/companies","href":"/api-reference/droplets/returns-an-array-of-companies-using-a-droplet"}]}]},{"group":"Developers","pages":[{"group":"API tokens","pages":[{"title":"returns an array of partner tokens","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/partner_tokens","href":"/api-reference/partner-tokens/returns-an-array-of-partner-tokens"},{"title":"creates a new partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/partner_tokens","href":"/api-reference/partner-tokens/creates-a-new-partner-token"},{"title":"returns a specific partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/partner_tokens/{id}","href":"/api-reference/partner-tokens/returns-a-specific-partner-token"},{"title":"updates a partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/partner_tokens/{id}","href":"/api-reference/partner-tokens/updates-a-partner-token"},{"title":"deletes a partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/partner_tokens/{id}","href":"/api-reference/partner-tokens/deletes-a-partner-token"},{"title":"Embeddable embeddable","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/embeddable","href":"/api-reference/tokens/embeddable-embeddable"},{"title":"returns an array of partner tokens","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/tokens/partner","href":"/api-reference/tokens/returns-an-array-of-partner-tokens"},{"title":"creates a new partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/partner","href":"/api-reference/tokens/creates-a-new-partner-token"},{"title":"returns a specific partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/tokens/partner/{id}","href":"/api-reference/tokens/returns-a-specific-partner-token"},{"title":"updates a partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml put /api/v2025-06/tokens/partner/{id}","href":"/api-reference/tokens/updates-a-partner-token"},{"title":"deletes a partner token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/tokens/partner/{id}","href":"/api-reference/tokens/deletes-a-partner-token"},{"title":"List the company's scoped clients","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/tokens/clients","href":"/api-reference/tokens/list-the-companys-scoped-clients"},{"title":"Create a scoped client","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/clients","href":"/api-reference/tokens/create-a-scoped-client"},{"title":"Rotate a scoped client's secret","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/clients/{client_id}/rotate","href":"/api-reference/tokens/rotate-a-scoped-clients-secret"},{"title":"Revoke a scoped client","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/clients/{client_id}/revoke","href":"/api-reference/tokens/revoke-a-scoped-client"},{"title":"List public tokens","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/tokens/public","href":"/api-reference/tokens/list-public-tokens"},{"title":"Create a public token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/tokens/public","href":"/api-reference/tokens/create-a-public-token"},{"title":"Delete a public token","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml delete /api/v2025-06/tokens/public/{id}","href":"/api-reference/tokens/delete-a-public-token"}]},{"group":"Mist apps","pages":[{"title":"List the current company's Mists, newest first","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists","href":"/api-reference/mists/list-the-current-companys-mists-newest-first"},{"title":"Provision a new Mist","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml post /api/v202604/mists","href":"/api-reference/mists/provision-a-new-mist"},{"title":"Show one Mist","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{id}","href":"/api-reference/mists/show-one-mist"},{"title":"Update a Mist (rename)","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml patch /api/v202604/mists/{id}","href":"/api-reference/mists/update-a-mist-rename"},{"title":"Schedule a Mist for destruction (15-day grace)","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml delete /api/v202604/mists/{id}","href":"/api-reference/mists/schedule-a-mist-for-destruction-15-day-grace"},{"title":"Cancel a pending teardown within the 15-day grace window","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml post /api/v202604/mists/{mist_id}/restore","href":"/api-reference/mists/cancel-a-pending-teardown-within-the-15-day-grace-window"},{"title":"List env vars on the Mist's Vercel project","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{mist_id}/env_vars","href":"/api-reference/mist_env_vars/list-env-vars-on-the-mists-vercel-project"},{"title":"Add a user-managed env var","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml post /api/v202604/mists/{mist_id}/env_vars","href":"/api-reference/mist_env_vars/add-a-user-managed-env-var"},{"title":"Update an env var's value","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml patch /api/v202604/mists/{mist_id}/env_vars/{key}","href":"/api-reference/mist_env_vars/update-an-env-vars-value"},{"title":"Remove an env var","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml delete /api/v202604/mists/{mist_id}/env_vars/{key}","href":"/api-reference/mist_env_vars/remove-an-env-var"},{"title":"List recent Vercel deployments for the Mist","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{mist_id}/deployments","href":"/api-reference/mist_code/list-recent-vercel-deployments-for-the-mist"},{"title":"Show one Vercel deployment","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{mist_id}/deployments/{id}","href":"/api-reference/mist_code/show-one-vercel-deployment"},{"title":"Runtime + build logs from a deployment","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{mist_id}/logs","href":"/api-reference/mist_code/runtime-+-build-logs-from-a-deployment"},{"title":"Visitors and page views for a Mist app","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml get /api/v202604/mists/{mist_id}/traffic","href":"/api-reference/mist_traffic/visitors-and-page-views-for-a-mist-app"},{"title":"Turn on visitor numbers for a Mist app","deprecated":null,"version":null,"openapi":"/api-reference/mist-v2026-04.yaml post /api/v202604/mists/{mist_id}/traffic/enablement","href":"/api-reference/mist_traffic/turn-on-visitor-numbers-for-a-mist-app"},{"title":"List attached custom domains","deprecated":null,"version":null,"openapi":"/api-reference/mist-domains-v2026-04.yaml get /api/v202604/mists/{mist_id}/domains","href":"/api-reference/mist_domains/list-attached-custom-domains"},{"title":"Attach a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/mist-domains-v2026-04.yaml post /api/v202604/mists/{mist_id}/domains","href":"/api-reference/mist_domains/attach-a-custom-domain"},{"title":"Inspect a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/mist-domains-v2026-04.yaml get /api/v202604/mists/{mist_id}/domains/{name}","href":"/api-reference/mist_domains/inspect-a-custom-domain"},{"title":"Detach a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/mist-domains-v2026-04.yaml delete /api/v202604/mists/{mist_id}/domains/{name}","href":"/api-reference/mist_domains/detach-a-custom-domain"}]},{"group":"Agent signup","pages":[{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company","href":"/api-reference/company-v0/public-companies/create-a-company"},{"title":"Resend the signup confirmation email for the current company","deprecated":null,"version":null,"openapi":"/api-reference/company-v0.yaml post /api/company/signup-confirmation","href":"/api-reference/company-v0/company/resend-the-signup-confirmation-email-for-the-current-company"}]},{"group":"Agent access requests","pages":[{"title":"List pending agent access requests","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml get /api/v2025-06/agent_access_requests","href":"/api-reference/agent_access_requests/list-pending-agent-access-requests"},{"title":"Approve an agent access request","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/agent_access_requests/{id}/approve","href":"/api-reference/agent_access_requests/approve-an-agent-access-request"},{"title":"Deny an agent access request","deprecated":null,"version":null,"openapi":"/api-reference/admin-v2025-06.yaml post /api/v2025-06/agent_access_requests/{id}/deny","href":"/api-reference/agent_access_requests/deny-an-agent-access-request"}]}]},{"group":"Unsorted endpoints","pages":[{"group":"company-member-sites-v2026-10","pages":[{"title":"Read the company's home site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml get /api/company/v2026-10/member-site-home","href":"/api-reference/member-site-home/read-the-companys-home-site"},{"title":"Set the company's home site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml put /api/company/v2026-10/member-site-home","href":"/api-reference/member-site-home/set-the-companys-home-site"},{"title":"Clear the company's home site","deprecated":null,"version":null,"openapi":"/api-reference/company-member-sites-v2026-10.yaml delete /api/company/v2026-10/member-site-home","href":"/api-reference/member-site-home/clear-the-companys-home-site"}]}]},{"group":"Portal \u0026 Widgets","pages":[{"group":"Portal Definition Reference","pages":[{"title":"Portal Definition Reference","href":"/portal-widgets/reference/portal-definition"},{"group":"Interfaces","pages":[{"href":"/portal-widgets/reference/portal-definition-types/interfaces/AlertWidgetNode","title":"AlertWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/AnnouncementWidgetNode","title":"AnnouncementWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/BulletListWidgetNode","title":"BulletListWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/CalendarWidgetNode","title":"CalendarWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/CardWidgetNode","title":"CardWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/CarouselWidgetNode","title":"CarouselWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/CatchUpWidgetNode","title":"CatchUpWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ChartWidgetNode","title":"ChartWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ContainerWidgetNode","title":"ContainerWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/EmbedWidgetNode","title":"EmbedWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ImageWidgetNode","title":"ImageWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/JsonObject","title":"JsonObject","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/LayoutWidgetNode","title":"LayoutWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/LinkWidgetNode","title":"LinkWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ListWidgetNode","title":"ListWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/MySiteWidgetNode","title":"MySiteWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/NestedWidgetNode","title":"NestedWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PlanEstimatorWidgetNode","title":"PlanEstimatorWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PointsWidgetNode","title":"PointsWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalCapabilityGrant","title":"PortalCapabilityGrant","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalDataSourceConfig","title":"PortalDataSourceConfig","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalDefinition","title":"PortalDefinition","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalNavigation","title":"PortalNavigation","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalNavigationItem","title":"PortalNavigationItem","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalProfile","title":"PortalProfile","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalResourceByKind","title":"PortalResourceByKind","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalScreen","title":"PortalScreen","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalTheme","title":"PortalTheme","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalThemeColor","title":"PortalThemeColor","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalThemeConfig","title":"PortalThemeConfig","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalThirdPartyWidgetNode","title":"PortalThirdPartyWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/PortalWidgetNodeBase","title":"PortalWidgetNodeBase","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/QuickLinksWidgetNode","title":"QuickLinksWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/QuickShareWidgetNode","title":"QuickShareWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/QuoteWidgetNode","title":"QuoteWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/RecentActivityWidgetNode","title":"RecentActivityWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/SeparatorWidgetNode","title":"SeparatorWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ShopWidgetNode","title":"ShopWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/SpacerWidgetNode","title":"SpacerWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/TableWidgetNode","title":"TableWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/TextWidgetNode","title":"TextWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/ToDoWidgetNode","title":"ToDoWidgetNode","tag":"INTERFACE"},{"href":"/portal-widgets/reference/portal-definition-types/interfaces/VideoWidgetNode","title":"VideoWidgetNode","tag":"INTERFACE"}]},{"group":"Type Aliases","pages":[{"href":"/portal-widgets/reference/portal-definition-types/types/ColorOption","title":"ColorOption","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/JsonPrimitive","title":"JsonPrimitive","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/JsonValue","title":"JsonValue","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/PortalBuiltinWidgetNode","title":"PortalBuiltinWidgetNode","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/PortalNetworkAccessGrant","title":"PortalNetworkAccessGrant","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/PortalResource","title":"PortalResource","tag":"TYPE"},{"href":"/portal-widgets/reference/portal-definition-types/types/PortalWidgetNode","title":"PortalWidgetNode","tag":"TYPE"}]}]},{"group":"Widget Worker SDK Reference","pages":[{"title":"Widget Worker SDK Reference","href":"/portal-widgets/reference/widget-worker"},{"group":"Classes","pages":[{"href":"/portal-widgets/reference/widget-worker-sdk/classes/PortalFunctionError","title":"PortalFunctionError","tag":"CLASS"}]},{"group":"Interfaces","pages":[{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/DeclarativeCapabilityUse","title":"DeclarativeCapabilityUse","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/DefineWidgetOptions","title":"DefineWidgetOptions","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/FluidSpacerWidgetProps","title":"FluidSpacerWidgetProps","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/PortalFunctionDefinition","title":"PortalFunctionDefinition","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/PortalFunctionImplementation","title":"PortalFunctionImplementation","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/RemoteDomWidgetWorkerController","title":"RemoteDomWidgetWorkerController","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/RuntimeSourceWidget","title":"RuntimeSourceWidget","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/SearchSortProps","title":"SearchSortProps","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/SourceWidget","title":"SourceWidget","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/SourceWidgetPackage","title":"SourceWidgetPackage","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/StartWidgetPackageOptions","title":"StartWidgetPackageOptions","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/WidgetSourceCapabilityDeclaration","title":"WidgetSourceCapabilityDeclaration","tag":"INTERFACE"},{"href":"/portal-widgets/reference/widget-worker-sdk/interfaces/WidgetSourcePropertySchema","title":"WidgetSourcePropertySchema","tag":"INTERFACE"}]},{"group":"Functions","pages":[{"href":"/portal-widgets/reference/widget-worker-sdk/functions/definePortalFunction","title":"definePortalFunction","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/defineWidget","title":"defineWidget","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/defineWidgetPackage","title":"defineWidgetPackage","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/FluidSpacerWidget","title":"FluidSpacerWidget","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/implementPortalFunction","title":"implementPortalFunction","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/prepareRemoteDomWidgetWorker","title":"prepareRemoteDomWidgetWorker","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/SearchSort","title":"SearchSort","tag":"FUNCTION"},{"href":"/portal-widgets/reference/widget-worker-sdk/functions/startWidgetPackage","title":"startWidgetPackage","tag":"FUNCTION"}]},{"group":"Type Aliases","pages":[{"href":"/portal-widgets/reference/widget-worker-sdk/types/AddContentMediaProductInput","title":"AddContentMediaProductInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/AddContentPlaylistItemInput","title":"AddContentPlaylistItemInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/AddMySiteFavoriteInput","title":"AddMySiteFavoriteInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/AnySourceWidget","title":"AnySourceWidget","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateContentMediaInput","title":"CreateContentMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateContentPlaylistInput","title":"CreateContentPlaylistInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateContentShareInput","title":"CreateContentShareInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateDamAssetInput","title":"CreateDamAssetInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateDamAssetPathInput","title":"CreateDamAssetPathInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateMySiteLinkInput","title":"CreateMySiteLinkInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/CreateTodoInput","title":"CreateTodoInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/DefineWidgetPackageOptions","title":"DefineWidgetPackageOptions","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/DeleteContentMediaInput","title":"DeleteContentMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/DeleteContentPlaylistInput","title":"DeleteContentPlaylistInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/DeleteMySiteFavoriteInput","title":"DeleteMySiteFavoriteInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/DeleteMySiteLinkInput","title":"DeleteMySiteLinkInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/FluidUiComponent","title":"FluidUiComponent","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/FullscreenState","title":"FullscreenState","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetAddressFieldsInput","title":"GetAddressFieldsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetContentMediaInput","title":"GetContentMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetEnrollmentPackInput","title":"GetEnrollmentPackInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetOrderInput","title":"GetOrderInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetPageInput","title":"GetPageInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetPlaylistInput","title":"GetPlaylistInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/GetProductInput","title":"GetProductInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListContentMediaInput","title":"ListContentMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListContentMediaProductsInput","title":"ListContentMediaProductsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListContentMetricsInput","title":"ListContentMetricsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListCountriesInput","title":"ListCountriesInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListDamAssetPathsInput","title":"ListDamAssetPathsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListOrdersInput","title":"ListOrdersInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListPagesInput","title":"ListPagesInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListPlaylistItemsInput","title":"ListPlaylistItemsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListPlaylistsInput","title":"ListPlaylistsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListProductMediaInput","title":"ListProductMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListProductMetricsInput","title":"ListProductMetricsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListProductsInput","title":"ListProductsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ListTodosInput","title":"ListTodosInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/MutateDamAssetInput","title":"MutateDamAssetInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalAddressFields","title":"PortalAddressFields","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalAppSummary","title":"PortalAppSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalCalendarEvent","title":"PortalCalendarEvent","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalContentFavoriteState","title":"PortalContentFavoriteState","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalCountry","title":"PortalCountry","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalDamAsset","title":"PortalDamAsset","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalDamAssetPath","title":"PortalDamAssetPath","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalEnrollmentPack","title":"PortalEnrollmentPack","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalEntityId","title":"PortalEntityId","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalFunction","title":"PortalFunction","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalFunctionErrorCode","title":"PortalFunctionErrorCode","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalFunctionHandler","title":"PortalFunctionHandler","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalFunctionJsonValue","title":"PortalFunctionJsonValue","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalImage","title":"PortalImage","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalLanguage","title":"PortalLanguage","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMedia","title":"PortalMedia","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMediaCta","title":"PortalMediaCta","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMediaProduct","title":"PortalMediaProduct","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMemberAccess","title":"PortalMemberAccess","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMetric","title":"PortalMetric","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMetricsPeriod","title":"PortalMetricsPeriod","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMySiteFavorite","title":"PortalMySiteFavorite","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMySiteLink","title":"PortalMySiteLink","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMySiteProfile","title":"PortalMySiteProfile","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalMySiteTheme","title":"PortalMySiteTheme","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalNamedEntitySummary","title":"PortalNamedEntitySummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalNavigationItem","title":"PortalNavigationItem","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalNavigationState","title":"PortalNavigationState","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalNavigationSummary","title":"PortalNavigationSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalNavigationTarget","title":"PortalNavigationTarget","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrder","title":"PortalOrder","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderAddress","title":"PortalOrderAddress","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderJsonValue","title":"PortalOrderJsonValue","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderLineItem","title":"PortalOrderLineItem","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderListStatus","title":"PortalOrderListStatus","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderMetafield","title":"PortalOrderMetafield","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderPaymentMethod","title":"PortalOrderPaymentMethod","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderShippingMethod","title":"PortalOrderShippingMethod","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderSummary","title":"PortalOrderSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderTaxTotals","title":"PortalOrderTaxTotals","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalOrderTrackingInformation","title":"PortalOrderTrackingInformation","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPage","title":"PortalPage","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPageContent","title":"PortalPageContent","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPageDetail","title":"PortalPageDetail","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPageInput","title":"PortalPageInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPlaylist","title":"PortalPlaylist","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPlaylistItem","title":"PortalPlaylistItem","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPlaylistItemContent","title":"PortalPlaylistItemContent","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPlaylistProduct","title":"PortalPlaylistProduct","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPointsLedger","title":"PortalPointsLedger","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalPointsLedgerEntry","title":"PortalPointsLedgerEntry","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalProduct","title":"PortalProduct","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalProductMedia","title":"PortalProductMedia","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalProductVariant","title":"PortalProductVariant","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalProfileSummary","title":"PortalProfileSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalScreenSummary","title":"PortalScreenSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalShare","title":"PortalShare","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalStore","title":"PortalStore","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalSummaryCollection","title":"PortalSummaryCollection","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalTodo","title":"PortalTodo","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/PortalTodoSummary","title":"PortalTodoSummary","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/QueryDropletDataInput","title":"QueryDropletDataInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/RemoveContentMediaProductInput","title":"RemoveContentMediaProductInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/RemoveContentPlaylistItemInput","title":"RemoveContentPlaylistItemInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ReorderContentPlaylistItemsInput","title":"ReorderContentPlaylistItemsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ReorderMySiteFavoritesInput","title":"ReorderMySiteFavoritesInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ReorderMySiteLinksInput","title":"ReorderMySiteLinksInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/SearchProductsInput","title":"SearchProductsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/ToggleContentFavoriteInput","title":"ToggleContentFavoriteInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateContentMediaInput","title":"UpdateContentMediaInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateContentPlaylistInput","title":"UpdateContentPlaylistInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateMySiteLinkInput","title":"UpdateMySiteLinkInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateMySiteProfileInput","title":"UpdateMySiteProfileInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateMySiteSettingsInput","title":"UpdateMySiteSettingsInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UpdateUserAccountInput","title":"UpdateUserAccountInput","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/UserAccount","title":"UserAccount","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/WidgetSourceDefaultProps","title":"WidgetSourceDefaultProps","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/WidgetSourcePropertyField","title":"WidgetSourcePropertyField","tag":"TYPE"},{"href":"/portal-widgets/reference/widget-worker-sdk/types/WidgetSourceResizable","title":"WidgetSourceResizable","tag":"TYPE"}]},{"group":"Variables","pages":[{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Accordion","title":"Accordion","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AccordionContent","title":"AccordionContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AccordionItem","title":"AccordionItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AccordionTrigger","title":"AccordionTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/addContentMediaProduct","title":"addContentMediaProduct","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/addContentPlaylistItem","title":"addContentPlaylistItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/addMySiteFavorite","title":"addMySiteFavorite","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Alert","title":"Alert","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDescription","title":"AlertDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialog","title":"AlertDialog","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogAction","title":"AlertDialogAction","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogCancel","title":"AlertDialogCancel","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogContent","title":"AlertDialogContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogDescription","title":"AlertDialogDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogFooter","title":"AlertDialogFooter","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogHeader","title":"AlertDialogHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogMedia","title":"AlertDialogMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogTitle","title":"AlertDialogTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertDialogTrigger","title":"AlertDialogTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AlertTitle","title":"AlertTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/allowAnchorUrl","title":"allowAnchorUrl","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Avatar","title":"Avatar","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AvatarBadge","title":"AvatarBadge","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AvatarFallback","title":"AvatarFallback","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AvatarGroup","title":"AvatarGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AvatarGroupCount","title":"AvatarGroupCount","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/AvatarImage","title":"AvatarImage","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Badge","title":"Badge","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Breadcrumb","title":"Breadcrumb","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbEllipsis","title":"BreadcrumbEllipsis","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbItem","title":"BreadcrumbItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbLink","title":"BreadcrumbLink","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbList","title":"BreadcrumbList","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbPage","title":"BreadcrumbPage","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/BreadcrumbSeparator","title":"BreadcrumbSeparator","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/buildPortalHref","title":"buildPortalHref","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Button","title":"Button","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Calendar","title":"Calendar","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Card","title":"Card","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardAction","title":"CardAction","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardContent","title":"CardContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardDescription","title":"CardDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardFooter","title":"CardFooter","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardHeader","title":"CardHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CardTitle","title":"CardTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Checkbox","title":"Checkbox","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Collapsible","title":"Collapsible","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CollapsibleContent","title":"CollapsibleContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CollapsibleTrigger","title":"CollapsibleTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Combobox","title":"Combobox","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Command","title":"Command","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandEmpty","title":"CommandEmpty","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandGroup","title":"CommandGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandInput","title":"CommandInput","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandItem","title":"CommandItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandList","title":"CommandList","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandSeparator","title":"CommandSeparator","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/CommandShortcut","title":"CommandShortcut","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createContentMedia","title":"createContentMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createContentPlaylist","title":"createContentPlaylist","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createContentShare","title":"createContentShare","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createDamAsset","title":"createDamAsset","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createDamAssetPath","title":"createDamAssetPath","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createMySiteLink","title":"createMySiteLink","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/createTodo","title":"createTodo","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DatePicker","title":"DatePicker","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/deleteContentMedia","title":"deleteContentMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/deleteContentPlaylist","title":"deleteContentPlaylist","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/deleteDamAsset","title":"deleteDamAsset","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/deleteMySiteFavorite","title":"deleteMySiteFavorite","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/deleteMySiteLink","title":"deleteMySiteLink","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Dialog","title":"Dialog","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogClose","title":"DialogClose","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogContent","title":"DialogContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogDescription","title":"DialogDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogFooter","title":"DialogFooter","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogHeader","title":"DialogHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogTitle","title":"DialogTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DialogTrigger","title":"DialogTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/discardDamAsset","title":"discardDamAsset","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenu","title":"DropdownMenu","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuCheckboxItem","title":"DropdownMenuCheckboxItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuContent","title":"DropdownMenuContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuGroup","title":"DropdownMenuGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuItem","title":"DropdownMenuItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuLabel","title":"DropdownMenuLabel","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuRadioGroup","title":"DropdownMenuRadioGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuRadioItem","title":"DropdownMenuRadioItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuSeparator","title":"DropdownMenuSeparator","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuShortcut","title":"DropdownMenuShortcut","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuSub","title":"DropdownMenuSub","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuSubContent","title":"DropdownMenuSubContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuSubTrigger","title":"DropdownMenuSubTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/DropdownMenuTrigger","title":"DropdownMenuTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/exitFullscreen","title":"exitFullscreen","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getAddressFields","title":"getAddressFields","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getContentMedia","title":"getContentMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getEnrollmentPack","title":"getEnrollmentPack","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getFullscreenState","title":"getFullscreenState","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getMemberAccess","title":"getMemberAccess","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getMySiteProfile","title":"getMySiteProfile","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getNavigationState","title":"getNavigationState","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getOrder","title":"getOrder","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getPage","title":"getPage","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getPlaylist","title":"getPlaylist","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getPointsLedger","title":"getPointsLedger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getPortalApp","title":"getPortalApp","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getPortalProfile","title":"getPortalProfile","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getProduct","title":"getProduct","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getStore","title":"getStore","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/getUserAccount","title":"getUserAccount","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/InfiniteScrollSentinel","title":"InfiniteScrollSentinel","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Input","title":"Input","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Label","title":"Label","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listCalendarEvents","title":"listCalendarEvents","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listContentMedia","title":"listContentMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listContentMediaProducts","title":"listContentMediaProducts","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listContentMetrics","title":"listContentMetrics","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listCountries","title":"listCountries","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listDamAssetPaths","title":"listDamAssetPaths","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listDamAssets","title":"listDamAssets","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listEnrollmentPacks","title":"listEnrollmentPacks","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listLanguages","title":"listLanguages","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listMySiteFavorites","title":"listMySiteFavorites","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listMySiteLinks","title":"listMySiteLinks","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listMySiteThemes","title":"listMySiteThemes","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listOrders","title":"listOrders","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listPages","title":"listPages","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listPlaylistItems","title":"listPlaylistItems","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listPlaylists","title":"listPlaylists","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listProductMedia","title":"listProductMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listProductMetrics","title":"listProductMetrics","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listProducts","title":"listProducts","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listShares","title":"listShares","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/listTodos","title":"listTodos","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/navigateTo","title":"navigateTo","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/networkAccess","title":"networkAccess","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Pagination","title":"Pagination","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationContent","title":"PaginationContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationEllipsis","title":"PaginationEllipsis","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationItem","title":"PaginationItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationLink","title":"PaginationLink","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationNext","title":"PaginationNext","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PaginationPrevious","title":"PaginationPrevious","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PhoneInput","title":"PhoneInput","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Popover","title":"Popover","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverAnchor","title":"PopoverAnchor","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverContent","title":"PopoverContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverDescription","title":"PopoverDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverHeader","title":"PopoverHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverTitle","title":"PopoverTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PopoverTrigger","title":"PopoverTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/PORTAL_ORDER_LIST_STATUSES","title":"PORTAL_ORDER_LIST_STATUSES","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Progress","title":"Progress","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/queryDropletData","title":"queryDropletData","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/RadioGroup","title":"RadioGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/RadioGroupItem","title":"RadioGroupItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/removeContentMediaProduct","title":"removeContentMediaProduct","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/removeContentPlaylistItem","title":"removeContentPlaylistItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/reorderContentPlaylistItems","title":"reorderContentPlaylistItems","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/reorderMySiteFavorites","title":"reorderMySiteFavorites","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/reorderMySiteLinks","title":"reorderMySiteLinks","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/requestFullscreen","title":"requestFullscreen","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/ScrollArea","title":"ScrollArea","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/ScrollBar","title":"ScrollBar","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/searchProducts","title":"searchProducts","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Select","title":"Select","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectContent","title":"SelectContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectGroup","title":"SelectGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectItem","title":"SelectItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectLabel","title":"SelectLabel","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectScrollDownButton","title":"SelectScrollDownButton","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectScrollUpButton","title":"SelectScrollUpButton","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectSeparator","title":"SelectSeparator","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectTrigger","title":"SelectTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SelectValue","title":"SelectValue","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Separator","title":"Separator","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Sheet","title":"Sheet","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetClose","title":"SheetClose","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetContent","title":"SheetContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetDescription","title":"SheetDescription","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetFooter","title":"SheetFooter","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetHeader","title":"SheetHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetTitle","title":"SheetTitle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SheetTrigger","title":"SheetTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Skeleton","title":"Skeleton","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Slider","title":"Slider","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Spinner","title":"Spinner","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/SpinnerWithText","title":"SpinnerWithText","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Switch","title":"Switch","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Table","title":"Table","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableBody","title":"TableBody","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableCaption","title":"TableCaption","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableCell","title":"TableCell","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableFooter","title":"TableFooter","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableHead","title":"TableHead","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableHeader","title":"TableHeader","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TableRow","title":"TableRow","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Tabs","title":"Tabs","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TabsContent","title":"TabsContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TabsList","title":"TabsList","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TabsTrigger","title":"TabsTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Textarea","title":"Textarea","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Toggle","title":"Toggle","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/toggleContentFavorite","title":"toggleContentFavorite","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/ToggleGroup","title":"ToggleGroup","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/ToggleGroupItem","title":"ToggleGroupItem","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/Tooltip","title":"Tooltip","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TooltipContent","title":"TooltipContent","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/TooltipTrigger","title":"TooltipTrigger","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateContentMedia","title":"updateContentMedia","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateContentPlaylist","title":"updateContentPlaylist","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateMySiteLink","title":"updateMySiteLink","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateMySiteProfile","title":"updateMySiteProfile","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateMySiteSettings","title":"updateMySiteSettings","tag":"VARIABLE"},{"href":"/portal-widgets/reference/widget-worker-sdk/variables/updateUserAccount","title":"updateUserAccount","tag":"VARIABLE"}]}]}]}]}]},"basePath":"","title":"Place the company's work on the board - Fluid","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DTNSD-0M.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}