Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.
Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>
When present, replaces the widget set for this dashboard transactionally. Widgets without id are created; widgets with an id matching an existing row are updated; widgets in the DB but absent from this array are deleted.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Alana Shopping B2B","description":"Help center and developer hub for Alana Shopping B2B — AI-powered product content platform for brands and retailers.","colors":{"primary":"#ff8086","light":"#ff8086","dark":"#ff8086"},"logo":{"light":"https://mintcdn.com/alana/Dr3xX14a3TaLPBgT/images/logo.svg?fit=max\u0026auto=format\u0026n=Dr3xX14a3TaLPBgT\u0026q=85\u0026s=f8ceb81884ba65a782265580405c98e3","dark":"https://mintcdn.com/alana/Dr3xX14a3TaLPBgT/images/logo-white.svg?fit=max\u0026auto=format\u0026n=Dr3xX14a3TaLPBgT\u0026q=85\u0026s=fa8d949b437d9de87f067f42621442c2","href":"https://alana.ai"},"favicon":"https://mintcdn.com/alana/Dr3xX14a3TaLPBgT/images/favicon.svg?fit=max\u0026auto=format\u0026n=Dr3xX14a3TaLPBgT\u0026q=85\u0026s=67a22eba367230becfd8a462a816847d","api":{"openapi":"openapi.json","playground":{"display":"interactive"}},"appearance":{"default":"system"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://app.alana.shopping","label":"Dashboard"}],"primary":{"type":"button","label":"Começar","href":"https://app.alana.shopping/auth/signup"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/alana-ai","github":"https://github.com/alana-ai"},"links":[{"header":"Produto","items":[{"label":"Dashboard","href":"https://app.alana.shopping"},{"label":"Motor de Conteúdo IA","href":"/pt/help/ai/how-ai-works"},{"label":"Integrações","href":"/pt/help/integrations/connecting-platforms"},{"label":"Planos e Preços","href":"/pt/help/account/plans-and-pricing"}]},{"header":"Desenvolvedores","items":[{"label":"Quickstart","href":"/pt/quickstart"},{"label":"Referência da API","href":"/pt/api-reference/overview"},{"label":"Guia de Webhooks","href":"/pt/guides/webhooks"},{"label":"Changelog","href":"/pt/changelog/overview"}]},{"header":"Empresa","items":[{"label":"Sobre a Alana","href":"https://alana.ai"},{"label":"Status do Sistema","href":"https://status.alana.shopping"},{"label":"Comunidade","href":"https://community.alana.ai"},{"label":"Fale com o Suporte","href":"mailto:support@alana.shopping"}]}]},"search":{"prompt":"Buscar na ajuda e docs..."},"seo":{"metatags":{"robots":"noindex, nofollow"}},"fonts":{"heading":{"family":"MuseoModerno","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"intercom":{"appId":"veyiki4k"}},"banner":{"content":"Bem-vindo ao nosso novo hub de docs! Central de Ajuda + Docs para Desenvolvedores em um só lugar.","dismissible":true},"errors":{"404":{"redirect":false,"title":"página não encontrada","description":"Esta página não existe ou pode ter sido movida. Tente buscar ou volte para a [Central de Ajuda](/pt/help/welcome)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"thumbnails":{"appearance":"light","fonts":{"family":"Inter"}},"metadata":{"timestamp":true},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":"pt/help/welcome"},{"language":"en","href":"en/help/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"alana","hasAudioNarration":false,"actualSubdomain":"alana","customDomains":["docs.alana.shopping"],"gitSource":{"type":"github","owner":"a-alanaai","repo":"shopping-b2b-v1","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab8cd53d3623a442e30ada6","collectionId":"ec538318-9dd1-4797-adf3-58756a6a8a4a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab8cd53d3623a442e30ada6"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abbe86b11ea8cb4851ab88b","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"en","tag":"API Reference","count":90},{"language":"pt-BR","tag":"Referência da API","count":90},{"language":"en","tag":"Help Center","count":35},{"language":"pt-BR","tag":"Central de Ajuda","count":35},{"language":"en","tag":"Documentation","count":27},{"language":"pt-BR","tag":"Documentação","count":27},{"language":"default","tag":"API Reference","count":20},{"language":"en","tag":"Guides","count":14},{"language":"pt-BR","tag":"Guias","count":14},{"language":"en","tag":"Brands","count":11},{"language":"pt-BR","tag":"Marcas","count":11},{"language":"en","tag":"Core Concepts","count":10},{"language":"pt-BR","tag":"Conceitos Fundamentais","count":10},{"language":"en","tag":"Catalogs","count":9},{"language":"en","tag":"MCP Tools","count":9},{"language":"pt-BR","tag":"Catálogos","count":9},{"language":"pt-BR","tag":"MCP Tools","count":9},{"language":"default","tag":"Search API v1","count":8},{"language":"en","tag":"Feed API","count":7},{"language":"en","tag":"Surfaces","count":7},{"language":"pt-BR","tag":"Feed API","count":7},{"language":"pt-BR","tag":"Surfaces","count":7},{"language":"default","tag":"Analytics","count":4},{"language":"default","tag":"Platform Adapters","count":4},{"language":"default","tag":"Platform Guides","count":3},{"language":"default","tag":"Reference","count":1},{"language":"default","tag":"Documentation","count":1},{"language":"default","tag":"Guides","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@alana.shopping","showHelpButton":true}},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"starterQuestions":[{"_id":"6992b47b0c445a8a6e628d35","deploymentId":"69913976347571420d709ca3","questionText":"How do I authenticate with the API?","status":"active","generatedBy":"manual","createdAt":"2026-02-16T06:08:59.400Z","updatedAt":"2026-02-16T06:08:59.400Z","__v":0},{"_id":"6992b4640c445a8a6e628d26","deploymentId":"69913976347571420d709ca3","questionText":"How does the AI content engine work?","status":"active","generatedBy":"manual","createdAt":"2026-02-16T06:08:36.976Z","updatedAt":"2026-02-16T06:08:36.976Z","__v":0},{"_id":"6992b44e0c445a8a6e628cf8","deploymentId":"69913976347571420d709ca3","questionText":"How do I create my first product catalog?","status":"active","generatedBy":"manual","createdAt":"2026-02-16T06:08:14.847Z","updatedAt":"2026-02-16T06:08:14.847Z","__v":0}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"en/api-reference/dashboards/update-dashboard","slug":"/en/api-reference/dashboards/update-dashboard","pageMetadata":{"title":"Update Dashboard","openapi":"PUT /api/workspace/{workspaceId}/dashboards/{dashboardId}","description":"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When `widgets` is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.","href":"/en/api-reference/dashboards/update-dashboard"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When \", _jsx(_components.code, {\n children: \"widgets\"\n }), \" is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\"]\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":"Update Dashboard","openapi":"PUT /api/workspace/{workspaceId}/dashboards/{dashboardId}","description":"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When `widgets` is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.","href":"/en/api-reference/dashboards/update-dashboard"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Dashboards"],"summary":"Update dashboard","description":"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When `widgets` is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.","operationId":"updateDashboard","parameters":["50c17f2b-71b2-4b45-b9e4-0a40eb31e5eb","809cc34e-fb2b-4a32-8484-b3cbb3a00b6b","87a709f5-a51f-4c44-950c-74de78b6f3d0","532aa033-2790-46d6-b394-037bc73d3510"],"requestBody":"a671758b-917d-4fa8-a2f6-70672b352a80","security":["9d6331d7-c0e9-4c9b-88e4-835981b1295d"],"responses":{"200":"f732976f-0de2-4426-b1f8-304900add66f","400":"e553a606-545b-46cb-8d92-56a5ee69f1a2","401":"127d471a-5f2a-4af4-988c-024fe46abc54","403":"43a2705b-91a5-4164-a771-5902c843dcc9","404":"3fee6f84-653b-424b-80d2-b4aba88daa4d","429":"513f00a5-5b0a-4005-85ba-dc912227d5d2","500":"e96bab1d-b169-4301-b028-f1c057739184"},"method":"put","type":"path","servers":["830d4d45-0527-4d8e-9a31-d689d45a6540"],"path":"/api/workspace/{workspaceId}/dashboards/{dashboardId}","baseUrlOptions":["https://app.alana.shopping"],"title":"Update dashboard","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"50c17f2b-71b2-4b45-b9e4-0a40eb31e5eb":{"name":"workspaceId","in":"path","required":true,"description":"The workspace ID","schema":{"type":"string","pattern":"^ws_[a-z0-9]+$","isRequired":true,"description":"The workspace ID","uniqueKey":"","typeLabel":"string"}},"809cc34e-fb2b-4a32-8484-b3cbb3a00b6b":{"name":"dashboardId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"87a709f5-a51f-4c44-950c-74de78b6f3d0":{"name":"X-Active-Brand","in":"header","required":false,"schema":{"type":"string","format":"uuid","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"532aa033-2790-46d6-b394-037bc73d3510":{"name":"brand_id","in":"query","required":false,"schema":{"type":"string","format":"uuid","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2000,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"layout":{"type":"object","required":["version","cols","rowHeight"],"properties":{"version":{"type":"integer","enum":[1],"isRequired":true,"uniqueKey":"layout.version","typeLabel":"enum\u003cinteger>"},"cols":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"layout.cols","typeLabel":"integer"},"rowHeight":{"type":"integer","minimum":16,"maximum":256,"isRequired":true,"uniqueKey":"layout.rowHeight","typeLabel":"integer"}},"uniqueKey":"layout","typeLabel":"object"},"widgets":{"type":"array","description":"When present, replaces the widget set for this dashboard transactionally. Widgets without `id` are created; widgets with an `id` matching an existing row are updated; widgets in the DB but absent from this array are deleted.","items":{"type":"object","required":["widget_type","position","config"],"properties":{"widget_type":{"type":"string","pattern":"^[a-z][a-z0-9_]{1,62}$","isRequired":true,"uniqueKey":"widgets.items.[INDEX].widget_type","typeLabel":"string"},"position":{"type":"object","required":["x","y","w","h"],"properties":{"x":{"type":"integer","minimum":0,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.x","typeLabel":"integer"},"y":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.y","typeLabel":"integer"},"w":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.w","typeLabel":"integer"},"h":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.h","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position","typeLabel":"object"},"config":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].config","typeLabel":"object"},"id":{"type":"string","format":"uuid","uniqueKey":"widgets.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"widgets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"widgets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","description":"\u003cstring>","widgets":[{"widget_type":"\u003cstring>","position":{"x":24,"y":1,"w":24,"h":24},"config":{},"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f732976f-0de2-4426-b1f8-304900add66f":{"description":"Dashboard + widgets after update","content":{"application/json":{"schema":{"type":"object","required":["dashboard","widgets"],"properties":{"dashboard":{"type":"object","required":["id","workspace_id","brand_id","slug","name","layout","created_by","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"dashboard.id","typeLabel":"string\u003cuuid>"},"workspace_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"dashboard.workspace_id","typeLabel":"string\u003cuuid>"},"brand_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"dashboard.brand_id","typeLabel":"string\u003cuuid>"},"slug":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,62}$","isRequired":true,"uniqueKey":"dashboard.slug","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"dashboard.name","typeLabel":"string"},"layout":{"type":"object","required":["version","cols","rowHeight"],"properties":{"version":{"type":"integer","enum":[1],"isRequired":true,"uniqueKey":"dashboard.layout.version","typeLabel":"enum\u003cinteger>"},"cols":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"dashboard.layout.cols","typeLabel":"integer"},"rowHeight":{"type":"integer","minimum":16,"maximum":256,"isRequired":true,"uniqueKey":"dashboard.layout.rowHeight","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"dashboard.layout","typeLabel":"object"},"created_by":{"type":"string","description":"Auth0 user_id (sub)","isRequired":true,"uniqueKey":"dashboard.created_by","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"dashboard.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"dashboard.updated_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"dashboard.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2000,"uniqueKey":"dashboard.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"dashboard.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"dashboard","typeLabel":"object"},"widgets":{"type":"array","items":{"type":"object","required":["id","dashboard_id","widget_type","position","config","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"widgets.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dashboard_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"widgets.items.[INDEX].dashboard_id","typeLabel":"string\u003cuuid>"},"widget_type":{"type":"string","pattern":"^[a-z][a-z0-9_]{1,62}$","description":"Registered widget type (e.g. counter, time_series, breakdown_bar, funnel, table, top_n)","isRequired":true,"uniqueKey":"widgets.items.[INDEX].widget_type","typeLabel":"string"},"position":{"type":"object","required":["x","y","w","h"],"properties":{"x":{"type":"integer","minimum":0,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.x","typeLabel":"integer"},"y":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.y","typeLabel":"integer"},"w":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.w","typeLabel":"integer"},"h":{"type":"integer","minimum":1,"maximum":48,"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position.h","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"widgets.items.[INDEX].position","typeLabel":"object"},"config":{"type":"object","additionalProperties":true,"description":"Widget-type-specific config (validated by registry's configSchema). Title and aggregation params live inside this object — there are no top-level title or aggregation columns.","isRequired":true,"uniqueKey":"widgets.items.[INDEX].config","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"widgets.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"widgets.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"widgets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"widgets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dashboard":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspace_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","slug":"\u003cstring>","name":"\u003cstring>","layout":{"version":1,"cols":24,"rowHeight":136},"created_by":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","description":"\u003cstring>"},"widgets":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dashboard_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","widget_type":"\u003cstring>","position":{"x":24,"y":1,"w":24,"h":24},"config":{},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e553a606-545b-46cb-8d92-56a5ee69f1a2":{"description":"Bad request - validation failed","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"Standardized error body (Phase 86-02)","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["UNAUTHORIZED","FORBIDDEN","NOT_FOUND","BAD_REQUEST","RATE_LIMITED","INTERNAL","CONFLICT"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error description","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Correlation ID for support and tracing","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"INVALID_REQUEST","details":{"field":"email","message":"Invalid email format"}},"examples":{"Example":{"title":"Example","value":{"error":"INVALID_REQUEST","details":{"field":"email","message":"Invalid email format"}}}},"exampleType":"examples"}},"exampleType":"examples"},"127d471a-5f2a-4af4-988c-024fe46abc54":{"description":"Unauthorized - authentication required","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"Standardized error body (Phase 86-02)","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["UNAUTHORIZED","FORBIDDEN","NOT_FOUND","BAD_REQUEST","RATE_LIMITED","INTERNAL","CONFLICT"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error description","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Correlation ID for support and tracing","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"UNAUTHORIZED","details":{"message":"Missing or invalid authentication token"}},"examples":{"Example":{"title":"Example","value":{"error":"UNAUTHORIZED","details":{"message":"Missing or invalid authentication token"}}}},"exampleType":"examples"}},"exampleType":"examples"},"43a2705b-91a5-4164-a771-5902c843dcc9":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"Standardized error body (Phase 86-02)","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["UNAUTHORIZED","FORBIDDEN","NOT_FOUND","BAD_REQUEST","RATE_LIMITED","INTERNAL","CONFLICT"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error description","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Correlation ID for support and tracing","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"FORBIDDEN","details":{"message":"User does not have permission to access this resource"}},"examples":{"Example":{"title":"Example","value":{"error":"FORBIDDEN","details":{"message":"User does not have permission to access this resource"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3fee6f84-653b-424b-80d2-b4aba88daa4d":{"description":"Not found - resource does not exist","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"Standardized error body (Phase 86-02)","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["UNAUTHORIZED","FORBIDDEN","NOT_FOUND","BAD_REQUEST","RATE_LIMITED","INTERNAL","CONFLICT"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error description","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Correlation ID for support and tracing","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"NOT_FOUND","details":{"message":"Resource not found"}},"examples":{"Example":{"title":"Example","value":{"error":"NOT_FOUND","details":{"message":"Resource not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"513f00a5-5b0a-4005-85ba-dc912227d5d2":{"description":"Too many requests — rate limit exceeded","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Maximum requests allowed in the window"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests remaining in the current window"},"Retry-After":{"schema":{"type":"integer"},"description":"Seconds until the rate limit resets"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Too many requests","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Too many requests"}}},"exampleType":"generated"}},"exampleType":"generated"},"e96bab1d-b169-4301-b028-f1c057739184":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"Standardized error body (Phase 86-02)","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["UNAUTHORIZED","FORBIDDEN","NOT_FOUND","BAD_REQUEST","RATE_LIMITED","INTERNAL","CONFLICT"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error description","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Correlation ID for support and tracing","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"INTERNAL_SERVER_ERROR","details":{"message":"An unexpected error occurred"}},"examples":{"Example":{"title":"Example","value":{"error":"INTERNAL_SERVER_ERROR","details":{"message":"An unexpected error occurred"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9d6331d7-c0e9-4c9b-88e4-835981b1295d":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: `Authorization: Bearer \u003ctoken>`","scopes":[]}}},"servers":{"830d4d45-0527-4d8e-9a31-d689d45a6540":{"url":"https://app.alana.shopping","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: `Authorization: Bearer \u003ctoken>`","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: `Authorization: Bearer \u003ctoken>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"alana","siteName":"Alana Shopping B2B","title":"Update Dashboard - Alana Shopping B2B","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/pt/api-reference/dashboards/update-dashboard","matchLevel":1},"en":{"href":"/en/api-reference/dashboards/update-dashboard","matchLevel":0}}},"lastModified":"2026-04-25T06:05:42.650Z","gitLastModified":"2026-04-25T06:04:09.000Z","originalFileLocation":"en/api-reference/dashboards/update-dashboard.mdx","locale":"en"},"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=\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Alana Shopping B2B\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_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/alana/mahZg_WJDAlT0TRo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Dashboard - Alana Shopping B2B\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Alana Shopping B2B\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://alana.mintlify.app/_mintlify/api/og/v2?division=Dashboards\u0026amp;title=Update+Dashboard\u0026amp;description=Update+dashboard+metadata+and+%28optionally%29+replace+its+widget+set+transactionally.+Admin+role+required.+When+%60widgets%60+is+omitted%2C+only+the+dashboard+row+is+upd\u0026amp;theme=751e9dfaae674d63c87e5ec3\u0026amp;signature=d357fe5e2764f1abb8e7e979b01090bb5d99ecfe9156a3cfe28cd9e42aeffdaa\">\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=\"Update Dashboard - Alana Shopping B2B\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://alana.mintlify.app/_mintlify/api/og/v2?division=Dashboards\u0026amp;title=Update+Dashboard\u0026amp;description=Update+dashboard+metadata+and+%28optionally%29+replace+its+widget+set+transactionally.+Admin+role+required.+When+%60widgets%60+is+omitted%2C+only+the+dashboard+row+is+upd\u0026amp;theme=751e9dfaae674d63c87e5ec3\u0026amp;signature=d357fe5e2764f1abb8e7e979b01090bb5d99ecfe9156a3cfe28cd9e42aeffdaa\">\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/alana/mahZg_WJDAlT0TRo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Alana Shopping B2B\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff8086\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/dashboards/update-dashboard.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.alana.shopping/#organization\",\"name\":\"Alana Shopping B2B\",\"url\":\"https://docs.alana.shopping\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/alana/Dr3xX14a3TaLPBgT/images/logo.svg?fit=max\u0026auto=format\u0026n=Dr3xX14a3TaLPBgT\u0026q=85\u0026s=f8ceb81884ba65a782265580405c98e3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.alana.shopping#website\",\"name\":\"Alana Shopping B2B\",\"url\":\"https://docs.alana.shopping\",\"publisher\":{\"@id\":\"https://docs.alana.shopping/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard#webpage\",\"url\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard\",\"name\":\"Update Dashboard\",\"description\":\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\",\"dateModified\":\"2026-04-25T06:04:09.000Z\",\"isPartOf\":{\"@id\":\"https://docs.alana.shopping#website\"},\"breadcrumb\":{\"@id\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dashboards\",\"item\":\"https://docs.alana.shopping/en/api-reference/dashboards/list-dashboards\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Dashboard\",\"item\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard#apireference\",\"headline\":\"Update Dashboard\",\"name\":\"Update Dashboard\",\"description\":\"Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.\",\"url\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.alana.shopping/en/api-reference/dashboards/update-dashboard#webpage\"},\"dateModified\":\"2026-04-25T06:04:09.000Z\",\"publisher\":{\"@id\":\"https://docs.alana.shopping/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.alana.shopping#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Alana Shopping B2B\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Alana Shopping B2B","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"pages":[{"title":"pt-BR","href":"/pt/api-reference/dashboards/update-dashboard"}]},{"language":"en","tabs":[{"tab":"Help Center","icon":"life-ring","pages":[{"title":"Help Center","href":"/en/help/welcome"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Overview","href":"/en/api-reference/overview"},{"title":"Authentication","href":"/en/api-reference/authentication"},{"title":"Errors","href":"/en/api-reference/errors"},{"title":"Rate Limits","href":"/en/api-reference/rate-limits"},{"title":"Pagination","href":"/en/api-reference/pagination"}]},{"group":"Workspace","pages":[{"title":"Get Workspace Settings","openapi":"GET /api/workspace/{workspaceId}/settings","href":"/en/api-reference/workspace/get-settings"},{"title":"Update Workspace Settings","openapi":"PATCH /api/workspace/{workspaceId}/settings","href":"/en/api-reference/workspace/update-settings"},{"title":"Get Security Settings","openapi":"GET /api/workspace/{workspaceId}/security","href":"/en/api-reference/workspace/get-security"},{"title":"Update Security Settings","openapi":"PATCH /api/workspace/{workspaceId}/security","href":"/en/api-reference/workspace/update-security"},{"title":"Export Workspace Data","openapi":"POST /api/workspace/{workspaceId}/export","href":"/en/api-reference/workspace/export-data"},{"title":"Get Audit Logs","openapi":"GET /api/workspace/{workspaceId}/audit-logs","href":"/en/api-reference/workspace/audit-logs"}]},{"group":"Members","pages":[{"title":"List Members","openapi":"GET /api/workspace/{workspaceId}/members","href":"/en/api-reference/members/list-members"},{"title":"Invite Member","openapi":"POST /api/workspace/{workspaceId}/members/invite","href":"/en/api-reference/members/invite-member"},{"title":"Get Member Details","openapi":"GET /api/workspace/{workspaceId}/members/{memberId}","href":"/en/api-reference/members/get-member"},{"title":"Update Member","openapi":"PATCH /api/workspace/{workspaceId}/members/{memberId}","href":"/en/api-reference/members/update-member"},{"title":"Remove Member","openapi":"DELETE /api/workspace/{workspaceId}/members/{memberId}","href":"/en/api-reference/members/remove-member"}]},{"group":"Brands","pages":[{"title":"List Brands","openapi":"GET /api/workspace/{workspaceId}/brands","href":"/en/api-reference/brands/list-brands"},{"title":"Create Brand","openapi":"POST /api/workspace/{workspaceId}/brands","href":"/en/api-reference/brands/create-brand"},{"title":"Get Brand Details","openapi":"GET /api/workspace/{workspaceId}/brands/{brandId}","href":"/en/api-reference/brands/get-brand"},{"title":"Update Brand","openapi":"PATCH /api/workspace/{workspaceId}/brands/{brandId}","href":"/en/api-reference/brands/update-brand"},{"title":"Delete Brand","openapi":"DELETE /api/workspace/{workspaceId}/brands/{brandId}","href":"/en/api-reference/brands/delete-brand"},{"title":"Get AI Specifications","openapi":"GET /api/workspace/{workspaceId}/brands/{brandId}/ai-specs","href":"/en/api-reference/brands/get-ai-specs"},{"title":"Update AI Specifications","openapi":"PATCH /api/workspace/{workspaceId}/brands/{brandId}/ai-specs","href":"/en/api-reference/brands/update-ai-specs"}]},{"group":"Dashboards","pages":[{"title":"List Dashboards","openapi":"GET /api/workspace/{workspaceId}/dashboards","href":"/en/api-reference/dashboards/list-dashboards"},{"title":"Create Dashboard","openapi":"POST /api/workspace/{workspaceId}/dashboards","href":"/en/api-reference/dashboards/create-dashboard"},{"title":"Get Dashboard","openapi":"GET /api/workspace/{workspaceId}/dashboards/{dashboardId}","description":"Get a single dashboard with its widget set in the active brand. Members can read.","href":"/en/api-reference/dashboards/get-dashboard"},{"title":"Update Dashboard","openapi":"PUT /api/workspace/{workspaceId}/dashboards/{dashboardId}","href":"/en/api-reference/dashboards/update-dashboard"},{"title":"Delete Dashboard","openapi":"DELETE /api/workspace/{workspaceId}/dashboards/{dashboardId}","description":"Delete a dashboard and all its widgets. Admin role required.","href":"/en/api-reference/dashboards/delete-dashboard"},{"title":"Run Aggregation","openapi":"POST /api/workspace/{workspaceId}/dashboards/aggregate","href":"/en/api-reference/dashboards/aggregate"}]},{"group":"Catalogs","pages":[{"title":"List Catalogs","openapi":"GET /api/workspace/{workspaceId}/catalogs","href":"/en/api-reference/catalogs/list-catalogs"},{"title":"Create Catalog","openapi":"POST /api/workspace/{workspaceId}/catalogs","href":"/en/api-reference/catalogs/create-catalog"},{"title":"Get Catalog Details","openapi":"GET /api/workspace/{workspaceId}/catalogs/{catalogId}","href":"/en/api-reference/catalogs/get-catalog"},{"title":"Update Catalog","openapi":"PATCH /api/workspace/{workspaceId}/catalogs/{catalogId}","href":"/en/api-reference/catalogs/update-catalog"},{"title":"Delete Catalog","openapi":"DELETE /api/workspace/{workspaceId}/catalogs/{catalogId}","href":"/en/api-reference/catalogs/delete-catalog"},{"title":"Publish Catalog","openapi":"POST /api/workspace/{workspaceId}/catalogs/{catalogId}/publish","href":"/en/api-reference/catalogs/publish"},{"title":"Unpublish Catalog","openapi":"POST /api/workspace/{workspaceId}/catalogs/{catalogId}/unpublish","href":"/en/api-reference/catalogs/unpublish"},{"title":"Fork Catalog","openapi":"POST /api/workspace/{workspaceId}/catalogs/{catalogId}/fork","href":"/en/api-reference/catalogs/fork"},{"title":"Merge Catalog","openapi":"POST /api/workspace/{workspaceId}/catalogs/{catalogId}/merge","href":"/en/api-reference/catalogs/merge"}]},{"group":"Products","pages":[{"title":"List Products","openapi":"GET /api/workspace/{workspaceId}/catalog/products","href":"/en/api-reference/products/list-products"},{"title":"Create Product","openapi":"POST /api/workspace/{workspaceId}/catalog/products","href":"/en/api-reference/products/create-product"},{"title":"Update Product","openapi":"PATCH /api/workspace/{workspaceId}/catalog/products","href":"/en/api-reference/products/update-product"},{"title":"Delete Product","openapi":"DELETE /api/workspace/{workspaceId}/catalog/products","href":"/en/api-reference/products/delete-product"},{"title":"Import Products","openapi":"POST /api/workspace/{workspaceId}/catalog/products/import","href":"/en/api-reference/products/import"}]},{"group":"Surfaces","pages":[{"title":"List Surfaces","openapi":"GET /api/workspace/{workspaceId}/surfaces","href":"/en/api-reference/surfaces/list-surfaces"},{"title":"Create Surface","openapi":"POST /api/workspace/{workspaceId}/surfaces","href":"/en/api-reference/surfaces/create-surface"},{"title":"Get Surface","openapi":"GET /api/workspace/{workspaceId}/surfaces/{surfaceKey}","href":"/en/api-reference/surfaces/get-surface"},{"title":"Update Surface","openapi":"PUT /api/workspace/{workspaceId}/surfaces/{surfaceKey}","href":"/en/api-reference/surfaces/update-surface"},{"title":"Delete Surface","openapi":"DELETE /api/workspace/{workspaceId}/surfaces/{surfaceKey}","href":"/en/api-reference/surfaces/delete-surface"},{"title":"Get Product Surface","openapi":"GET /api/workspace/{workspaceId}/products/{productId}/surfaces/{surfaceKey}","href":"/en/api-reference/surfaces/get-product-surface"},{"title":"Set Product Surface Overrides","openapi":"PUT /api/workspace/{workspaceId}/products/{productId}/surfaces/{surfaceKey}","href":"/en/api-reference/surfaces/upsert-product-surface"}]},{"group":"AI Services","pages":[{"title":"Chat with AI","openapi":"POST /api/ai/chat","href":"/en/api-reference/ai/chat"},{"title":"Generate with AI","openapi":"POST /api/ai/generate","href":"/en/api-reference/ai/generate"},{"title":"Enhance with AI","openapi":"POST /api/ai/enhance","href":"/en/api-reference/ai/enhance"}]},{"group":"Billing","pages":[{"title":"Get Billing Overview","openapi":"GET /api/workspace/{workspaceId}/billing","href":"/en/api-reference/billing/get-billing"},{"title":"Create Checkout Session","openapi":"POST /api/workspace/{workspaceId}/billing/checkout","href":"/en/api-reference/billing/create-checkout"},{"title":"Get Billing Portal URL","openapi":"GET /api/workspace/{workspaceId}/billing/portal","href":"/en/api-reference/billing/portal"},{"title":"Get Invoices","openapi":"GET /api/workspace/{workspaceId}/billing/invoices","href":"/en/api-reference/billing/invoices"},{"title":"Get Usage Statistics","openapi":"GET /api/workspace/{workspaceId}/billing/usage","href":"/en/api-reference/billing/usage"}]},{"group":"API Keys","pages":[{"title":"List API Keys","openapi":"GET /api/workspace/{workspaceId}/api-keys","href":"/en/api-reference/api-keys/list-keys"},{"title":"Create API Key","openapi":"POST /api/workspace/{workspaceId}/api-keys","href":"/en/api-reference/api-keys/create-key"},{"title":"Revoke API Key","openapi":"DELETE /api/workspace/{workspaceId}/api-keys/{keyId}","href":"/en/api-reference/api-keys/revoke-key"}]},{"group":"Integrations","pages":[{"title":"Authorize Integration","openapi":"POST /api/integrations/authorize","href":"/en/api-reference/integrations/authorize"},{"title":"Get Integration Status","openapi":"GET /api/integrations/status","href":"/en/api-reference/integrations/status"},{"title":"Sync Integration","openapi":"POST /api/integrations/sync","href":"/en/api-reference/integrations/sync"}]},{"group":"Reference","pages":[{"title":"Error Reference","href":"/api-reference/errors"}]},{"group":"Search API v1","pages":[{"title":"Search Products","api":"POST /api/v1/search","href":"/api-reference/v1/search"},{"title":"Autocomplete","api":"GET /api/v1/autocomplete","href":"/api-reference/v1/autocomplete"},{"title":"Facet Configuration","href":"/api-reference/v1/facet-configs"},{"title":"Browse","api":"POST /api/v1/browse","href":"/api-reference/v1/browse"},{"title":"Events","api":"POST /api/v1/events","href":"/api-reference/v1/events"},{"title":"Boost Rules","href":"/api-reference/v1/boost-rules"},{"title":"Recommendations","api":"POST /api/v1/recommend","href":"/api-reference/v1/recommend"},{"title":"Synonyms","href":"/api-reference/v1/synonyms"}]},{"group":"Platform Adapters","pages":[{"title":"Platform Adapters","href":"/api-reference/v1/platform-adapters"},{"title":"VTEX IO Installation","href":"/api-reference/v1/vtex-installation"},{"title":"Shopify Installation","href":"/api-reference/v1/shopify-installation"},{"title":"Nuvemshop Installation","href":"/api-reference/v1/nuvemshop-installation"}]},{"group":"Analytics","pages":[{"title":"Top Searches","openapi":"GET /api/v1/analytics/top-searches","href":"/api-reference/analytics/top-searches"},{"title":"No-Results Queries","openapi":"GET /api/v1/analytics/no-results","href":"/api-reference/analytics/no-results"},{"title":"Click-Through Rate","openapi":"GET /api/v1/analytics/ctr","href":"/api-reference/analytics/ctr"},{"title":"Facet Usage","openapi":"GET /api/v1/analytics/facet-usage","href":"/api-reference/analytics/facet-usage"}]},{"group":"Feed API","pages":[{"title":"Feed API Overview","href":"/en/api-reference/feed/overview"},{"title":"Feed API Authentication","href":"/en/api-reference/feed/authentication"},{"title":"Fetching Feeds","href":"/en/api-reference/feed/fetching-feeds"},{"title":"Google Merchant Center","href":"/en/api-reference/feed/google-merchant"},{"title":"Meta Commerce","href":"/en/api-reference/feed/meta-commerce"},{"title":"Feed Webhooks","href":"/en/api-reference/feed/webhooks"},{"title":"Feed Analytics","href":"/en/api-reference/feed/analytics"}]},{"group":"MCP Tools","pages":[{"title":"MCP Tools Overview","href":"/en/api-reference/mcp/overview"},{"title":"MCP Authentication","href":"/en/api-reference/mcp/authentication"},{"title":"Connecting Agents","href":"/en/api-reference/mcp/connecting-agents"},{"title":"Discovery Tools","href":"/en/api-reference/mcp/discovery-tools"},{"title":"Commerce Tools","href":"/en/api-reference/mcp/commerce-tools"},{"title":"Media \u0026 Context Tools","href":"/en/api-reference/mcp/media-context-tools"},{"title":"Analytics Tools","href":"/en/api-reference/mcp/analytics-tools"},{"title":"MCP Resources \u0026 Prompts","href":"/en/api-reference/mcp/resources-prompts"},{"title":"Tool Filtering","href":"/en/api-reference/mcp/tool-filtering"}]},{"group":"Data Pipeline","pages":[{"title":"Pipeline API Overview","icon":"workflow","href":"/en/api-reference/pipeline/overview"},{"title":"Batch Silver","icon":"filter","href":"/en/api-reference/pipeline/batch-silver"},{"title":"Batch Gold","icon":"star","href":"/en/api-reference/pipeline/batch-gold"},{"title":"Pipeline Settings API","icon":"settings","href":"/en/api-reference/pipeline/settings"}]},{"group":"Marketplace Hub","pages":[{"title":"Hub API Overview","icon":"store","href":"/en/api-reference/hub/overview"},{"title":"Browse Catalogs","icon":"search","href":"/en/api-reference/hub/browse-catalogs"},{"title":"Preview Catalog","icon":"eye","href":"/en/api-reference/hub/preview"},{"title":"Clone \u0026 Subscribe","icon":"copy","href":"/en/api-reference/hub/clone-subscribe"},{"title":"Sync \u0026 Conflicts","icon":"refresh","href":"/en/api-reference/hub/sync-conflicts"},{"title":"Publisher Analytics","icon":"chart-bar","href":"/en/api-reference/hub/publisher-analytics"}]},{"group":"Platform Guides","pages":[{"title":"VTEX Quickstart","href":"/api-reference/quickstart-vtex"},{"title":"Shopify Quickstart","href":"/api-reference/quickstart-shopify"},{"title":"Nuvemshop Quickstart","href":"/api-reference/quickstart-nuvemshop"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/en/changelog/overview"}]},{"tab":"System Status","icon":"signal","href":"https://status.alana.shopping"}]}]},"title":"Update Dashboard - Alana Shopping B2B","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}