adminClient.getWorkflows().startWorkflow(workflowToRun.getId(), new StartWorkflowRequestBody.Builder(new StartWorkflowRequestBodyFlowField.Builder().type("flow").id(workflowToRun.getFlows().get(0).getId()).build(), Arrays.asList(new StartWorkflowRequestBodyFilesField.Builder().type(StartWorkflowRequestBodyFilesTypeField.FILE).id(workflowFileId).build()), new StartWorkflowRequestBodyFolderField.Builder().type(StartWorkflowRequestBodyFolderTypeField.FOLDER).id(workflowFolderId).build()).type(StartWorkflowRequestBodyTypeField.WORKFLOW_PARAMETERS).build())
await adminClient.Workflows.StartWorkflowAsync(workflowId: NullableUtils.Unwrap(workflowToRun.Id), requestBody: new StartWorkflowRequestBody(flow: new StartWorkflowRequestBodyFlowField() { Type = "flow", Id = NullableUtils.Unwrap(NullableUtils.Unwrap(workflowToRun.Flows)[0].Id) }, files: Array.AsReadOnly(new [] {new StartWorkflowRequestBodyFilesField() { Type = StartWorkflowRequestBodyFilesTypeField.File, Id = workflowFileId }}), folder: new StartWorkflowRequestBodyFolderField() { Type = StartWorkflowRequestBodyFolderTypeField.Folder, Id = workflowFolderId }) { Type = StartWorkflowRequestBodyTypeField.WorkflowParameters });
adminClient.getWorkflows().startWorkflow(workflowToRun.getId(), new StartWorkflowRequestBody.Builder(new StartWorkflowRequestBodyFlowField.Builder().type("flow").id(workflowToRun.getFlows().get(0).getId()).build(), Arrays.asList(new StartWorkflowRequestBodyFilesField.Builder().type(StartWorkflowRequestBodyFilesTypeField.FILE).id(workflowFileId).build()), new StartWorkflowRequestBodyFolderField.Builder().type(StartWorkflowRequestBodyFolderTypeField.FOLDER).id(workflowFolderId).build()).type(StartWorkflowRequestBodyTypeField.WORKFLOW_PARAMETERS).build())
await adminClient.Workflows.StartWorkflowAsync(workflowId: NullableUtils.Unwrap(workflowToRun.Id), requestBody: new StartWorkflowRequestBody(flow: new StartWorkflowRequestBodyFlowField() { Type = "flow", Id = NullableUtils.Unwrap(NullableUtils.Unwrap(workflowToRun.Flows)[0].Id) }, files: Array.AsReadOnly(new [] {new StartWorkflowRequestBodyFilesField() { Type = StartWorkflowRequestBodyFilesTypeField.File, Id = workflowFileId }}), folder: new StartWorkflowRequestBodyFolderField() { Type = StartWorkflowRequestBodyFolderTypeField.Folder, Id = workflowFolderId }) { Type = StartWorkflowRequestBodyTypeField.WorkflowParameters });
A configurable outcome the workflow should complete.
Show child attributes
Response
Starts the workflow.
Last modified on January 23, 2026
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Box Dev Docs","description":"Box for Developers: guides, API reference, SDKs, and tutorials for building content management, Box AI, and enterprise integrations.","colors":{"primary":"#0061d5","light":"#f6fafd","dark":"#002947"},"logo":{"light":"https://mintcdn.com/box/lJLw9z7FWORNWMcq/logo/boxdev-light.png?fit=max\u0026auto=format\u0026n=lJLw9z7FWORNWMcq\u0026q=85\u0026s=a11710b698ff59d24426f9ecec6c7e9c","dark":"https://mintcdn.com/box/siVVIgx7pBuvW4ua/logo/boxdev-dark.svg?fit=max\u0026auto=format\u0026n=siVVIgx7pBuvW4ua\u0026q=85\u0026s=0e34af393abb1b8c024258d684bb7732"},"favicon":"https://mintcdn.com/box/T2hwpVFBJMA4eeDs/favicon.ico?fit=max\u0026auto=format\u0026n=T2hwpVFBJMA4eeDs\u0026q=85\u0026s=2a2efcc60e46eca7ee3ebbe650c47350","api":{"examples":{"languages":["curl","python","node","swift","java",".Net"],"autogenerate":false}},"seo":{"metatags":{"google-site-verification":"fuelbNhVR1kQluNBJjYt4K1Hj5HvJLhLnIq0o9CAY9E"}},"fonts":{"family":"Inter"},"contextual":{"options":[{"title":"Install Box Agent Skills","description":"Add Box plugins to your AI assistants","icon":"sparkles","href":"/ai/agent-skills"},"cursor","vscode","mcp","chatgpt","claude","perplexity","copy","view"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"Resources","items":[{"label":"Newsletter unsubscribe","href":"https://go.box.com/preferences.html"},{"label":"Terms of Use","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"Privacy Policy","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookie Notification","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"Log in","type":"button"}],"primary":{"type":"button","label":"Get started for free","href":"https://account.box.com/signup/developer"}},"href":""},{"language":"ja","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"リソース","items":[{"label":"ニュースレターの登録解除","href":"https://go.box.com/preferences.html"},{"label":"利用規約","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"個人情報保護方針","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookieに関する通知","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"ログイン","type":"button"}],"primary":{"type":"button","label":"今すぐ無料で開始","href":"https://account.box.com/signup/developer"}},"href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"box","hasAudioNarration":false,"actualSubdomain":"box","customDomains":["developer.box.com"],"gitSource":{"type":"github","owner":"box","repo":"box-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8633d4729f9837cf1496b","collectionId":"dc91baf9-de52-497b-be84-3b4701341d9f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8633d4729f9837cf1496b"},"feedback":{"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9e85e69138fe59fdabd4d","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"en","tag":"API reference","count":680},{"language":"ja","tag":"APIリファレンス","count":636},{"language":"ja","tag":"ホーム","count":368},{"language":"en","tag":"Home","count":302},{"language":"ja","tag":"AI","count":191},{"language":"en","tag":"AI","count":177},{"language":"ja","tag":"コラボレーション","count":81},{"language":"ja","tag":"ツール","count":77},{"language":"ja","tag":"開発ツール","count":77},{"language":"ja","tag":"メタデータと検索","count":67},{"language":"en","tag":"Tools","count":62},{"language":"en","tag":"Dev tools","count":62},{"language":"ja","tag":"コンテンツ","count":58},{"language":"en","tag":"Metadata \u0026 search","count":56},{"language":"en","tag":"Collaboration","count":50},{"language":"en","tag":"Content","count":49},{"language":"ja","tag":"メタデータ","count":49},{"language":"en","tag":"Supported AI models","count":47},{"language":"en","tag":"v2026.0","count":47},{"language":"ja","tag":"サポートされているAIモデル","count":46}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"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":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"a code{border-bottom-color:none!important}.prose :where(a code):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:inherit;font-weight:inherit;text-decoration:none;text-decoration-color:rgb(var(--primary));text-underline-offset:0;text-decoration-thickness:1px}#consent_blackbar{position:relative;z-index:9999999!important}#sidebar,.left-0.right-0.sticky.sm\\:px-4.pb-4.sm\\:pb-6.bottom-0.pt-1.flex.flex-col.items-center.w-full.overflow-hidden.z-20{z-index:1}#footer>div,#sidebar-content{z-index:0}a.nav-anchor img[src$=\"/images/sidebar/box.svg\"]{background-color:transparent!important}#truste-consent-track{z-index:9999999!important;position:fixed!important}.dark #truste-consent-track{background-color:#151f26!important;border-color:#1a1a1a}.dark #truste-show-consent{background-color:#fff;color:#151f26}.dark #truste-consent-text{color:#fff}#truste-consent-content{max-width:1400px}.homepage_container .card img{max-height:200px}.homepage_container h1 span,.homepage_container h2 span{margin:auto}#navbar .max-w-8xl.mx-auto.relative button .ml-4.flex.text-sm.leading-6.whitespace-nowrap.min-w-0.space-x-3.overflow-hidden,header#header .eyebrow{display:none!important}.sidebar-group-header:has(+.sidebar-group>li:is(\n [id=\"/reference\"],\n [id=\"/ja/reference\"],\n [id=\"/ja/reference/v2025.0\"],\n [id=\"/ja/reference/v2026.0\"]\n))>.sidebar-title{display:none}footer div.flex.gap-4.flex-col.md\\:flex-row.md\\:items-center.md\\:gap-8.md\\:justify-center{flex-wrap:wrap}footer div.flex.gap-4.flex-col.md\\:flex-row.md\\:items-center.md\\:gap-8.md\\:justify-center a{white-space:nowrap;text-overflow:clip;overflow:visible;align-self:start;flex-shrink:0;cursor:pointer!important}#google-preferred-source-column{display:flex;flex-direction:column;align-items:flex-end;flex:0 0 auto;width:max-content;max-width:100%}#google-preferred-source{display:flex;justify-content:flex-end;width:auto;margin:0;padding-top:16px}.google-preferred-source-button{appearance:none;margin:0;padding:0;border:0;background:0 0;line-height:0;cursor:pointer}.google-preferred-source-badge{display:block;width:140px;max-width:100%;height:auto}.dark .google-preferred-source-badge--light,.google-preferred-source-badge--dark{display:none}.dark .google-preferred-source-badge--dark{display:block}.nav-logo{min-width:109px}.badge-guide,.badge-quickstart,.badge-tutorial,.dark .badge-guide,.dark .badge-quickstart,.dark .badge-tutorial{background-color:#1f2937;color:#fff}.badge-get{background-color:rgb(74 222 128/.2);color:#15803d}.dark .badge-get{color:#4ade80}.badge-post{background-color:rgb(96 165 250/.2);color:#1d4ed8}.dark .badge-post{color:#60a5fa}.badge-patch,.badge-put{background-color:rgb(250 204 21/.2);color:#a16207}.dark .badge-patch,.dark .badge-put{color:#facc15}.badge-delete{background-color:rgb(248 113 113/.2);color:#b91c1c}.dark .badge-delete{color:#f87171}.badge-api{background-color:#e3f2fd;color:#0d47a1}.dark .badge-api{background-color:#0d47a1;color:#bbdefb}.badge-documentation,.badge-reference,.dark .badge-documentation,.dark .badge-reference{background-color:#000;color:#fff}.badge-default{background-color:#f5f5f5;color:#424242}.badge-group{display:inline-flex;gap:.5rem;flex-wrap:wrap}.dark .badge-default{background-color:#424242;color:#e0e0e0}.update>div:first-child>div:nth-child(3){padding:0;order:4}.update>div:first-child>div:nth-child(3)>span{display:flex;padding:.25rem .75rem;align-items:center;border-radius:9999px;font-size:.875rem;line-height:1.25rem;color:#374151;background-color:#f3f4f6}.dark .update>div:first-child>div:nth-child(3)>span{color:#cecece;background-color:#161616}.update>div:first-child>div:nth-child(4){order:3}div#banner a{text-decoration:none!important;color:#fff;font-weight:600}nav ul #topbar-cta-button a span,nav ul .navbar-link a{border-radius:50px!important}nav ul #topbar-cta-button a span{background-color:#0061d5}#topbar-cta-button a:hover span{opacity:1!important;background-color:#146bd5}.dark #topbar-cta-button a:hover span{opacity:1!important;background-color:#0058c3}.signup-cta-button,.signup-cta-button:active,.signup-cta-button:focus,.signup-cta-button:hover{background-color:#0061d5;border-radius:50px!important;transition:background-color .2s!important;box-shadow:none!important;transform:none!important;border:0!important;border-bottom:none!important;text-decoration:none!important;outline:0!important}.signup-cta-button:hover{background-color:#146bd5!important;opacity:1!important}.dark .signup-cta-button:hover{background-color:#0058c3!important;opacity:1!important}.homepage-secondary-button,.homepage-secondary-button:active,.homepage-secondary-button:focus,.homepage-secondary-button:hover{border-radius:50px!important;border:1px solid #d1d5db!important;background-color:transparent!important;color:#1f2937!important;transition:background-color .2s!important;box-shadow:none!important;transform:none!important;text-decoration:none!important;outline:0!important}.homepage-secondary-button:hover{background-color:#f9fafb!important}.dark .homepage-secondary-button,.dark .homepage-secondary-button:active,.dark .homepage-secondary-button:focus{border-color:#4b5563!important;color:#e5e7eb!important}.dark .homepage-secondary-button:hover{background-color:#1f2937!important}.signup-cta-login,.signup-cta-login:active,.signup-cta-login:focus,.signup-cta-login:hover{text-decoration:none!important;border-bottom:none!important}#content-area h1,#content-area h2,#content-area h3,#content-area h4,#content-area h5,#content-area h6{font-weight:600!important}#content-area h1{font-size:32px!important}.dark img[src*=\"guides-box-ai-ai-models/claude.svg\"],.dark img[src*=\"guides-box-ai-ai-models/gemini.svg\"],.dark img[src*=\"guides-box-ai-ai-models/grok.svg\"],.dark img[src*=\"guides-box-ai-ai-models/meta.svg\"],.dark img[src*=\"guides-box-ai-ai-models/mistral.svg\"],.dark img[src*=\"guides-box-ai-ai-models/openai.svg\"]{filter:invert(1)}.homepage_h2{font-size:28px!important}.chat-assistant-floating-input{z-index:1!important}"}],"page":{"pagePath":"reference/post-workflows-id-start","slug":"/reference/post-workflows-id-start","pageMetadata":{"title":"Starts workflow based on request body","openapi":"box-openapi.json POST /workflows/{workflow_id}/start","description":"Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console.","href":"/reference/post-workflows-id-start"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Initiates a flow with a trigger type of \", _jsx(_components.code, {\n children: \"WORKFLOW_MANUAL_START\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"You application must be authorized to use the \", _jsx(_components.code, {\n children: \"Manage Box Relay\"\n }), \" application scope within the developer console.\"]\n })]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(Note,{children:[_jsxs(_components.p,{children:[`This endpoint is in the version `,_jsx(_components.strong,{children:`2024.0`}),`. No changes are required to continue using it. For more details, see `,_jsx(_components.strong,{children:_jsx(_components.a,{href:`/guides/api-calls/api-versioning-strategy`,children:`Box API versioning`})}),`.`]}),_jsxs(_components.p,{children:[`Learn more about `,_jsx(_components.a,{href:`/guides/tooling/sdks/sdk-versioning/`,children:`Box SDK versioning strategy`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Starts workflow based on request body","openapi":"box-openapi.json POST /workflows/{workflow_id}/start","description":"Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console.","href":"/reference/post-workflows-id-start"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/box/523776d2eff70e58/scripts/cookie-banner.js","/_mintlify/custom/box/e597cec886c1778e/scripts/locale-links.js","/_mintlify/custom/box/37b2f846ed414abc/snippets/choose-choice-simple.js","/_mintlify/custom/box/78fc14bb599966cb/scripts/locale-footer-combined.js","/_mintlify/custom/box/9a429216167d598a/scripts/analitics.js","/_mintlify/custom/box/2f463a090bfcd0e8/snippets/boxIntl.js","/_mintlify/custom/box/d88c3906cf95ec86/snippets/translations.js","/_mintlify/custom/box/d67e74fc334b686a/scripts/preferred-source.js"],"openApiReferenceData":{"operation":{"operationId":"post_workflows_id_start","summary":"Starts workflow based on request body","description":"Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console.","parameters":["aa3199a1-39f3-4a44-a982-27e28f0ccdfa"],"requestBody":"f6e20eda-c83c-4e1b-a206-65ec51a1d4ed","responses":{"204":"54176268-b7cc-46a1-9b17-b965b4cb8824","400":"ca421ebf-d83e-47e3-9f13-42288fdf0c68","403":"da75a7e2-f825-4f1c-ac96-1623f3569fb2","404":"1c1bb587-05d8-49f3-b535-03cc303f4c4b","default":"1cde97c3-29de-4632-a51d-fcf09675ceee"},"x-box-tag":"workflows","tags":["Workflows"],"x-codeSamples":[{"lang":"curl","label":"Starts workflow based on request body","source":"curl -i -X POST \"https://api.box.com/2.0/workflows/42037322/start\" \\\n -H \"authorization: Bearer \u003cACCESS_TOKEN>\" \\\n -d '{\n \"type\": \"workflow_parameters\",\n \"flow\": {\n \"id\": \"8937625\",\n \"type\": \"flow\"\n },\n \"files\": [{\n \"type\": \"file\",\n \"id\": \"389047572\"\n },\n {\n \"type\": \"file\",\n \"id\": \"389047578\"\n }],\n \"folder\": {\n \"id\": \"2233212\",\n \"type\": \"folder\"\n },\n \"outcomes\": [\n {\n \"id\": \"34895783\",\n \"type\": \"outcome\",\n \"task_collaborators\": {\n \"type\": \"variable\",\n \"variable_type\": \"user_list\",\n \"variable_value\": [{ \"type\": \"user\", \"id\": \"890273642\" }]\n },\n \"completion_rule\": {\n \"type\": \"variable\",\n \"variable_type\": \"task_completion_rule\",\n \"variable_value\": \"all_assignees\"\n },\n \"file_collaborator_role\": {\n \"type\": \"variable\",\n \"variable_type\": \"collaborator_role\",\n \"variable_value\": \"viewer\"\n }\n }\n ]\n }'"},{"lang":"dotnet","label":"Starts workflow based on request body","source":"await adminClient.Workflows.StartWorkflowAsync(workflowId: NullableUtils.Unwrap(workflowToRun.Id), requestBody: new StartWorkflowRequestBody(flow: new StartWorkflowRequestBodyFlowField() { Type = \"flow\", Id = NullableUtils.Unwrap(NullableUtils.Unwrap(workflowToRun.Flows)[0].Id) }, files: Array.AsReadOnly(new [] {new StartWorkflowRequestBodyFilesField() { Type = StartWorkflowRequestBodyFilesTypeField.File, Id = workflowFileId }}), folder: new StartWorkflowRequestBodyFolderField() { Type = StartWorkflowRequestBodyFolderTypeField.Folder, Id = workflowFolderId }) { Type = StartWorkflowRequestBodyTypeField.WorkflowParameters });"},{"lang":"swift","label":"Starts workflow based on request body","source":"try await adminClient.workflows.startWorkflow(workflowId: workflowToRun.id!, requestBody: StartWorkflowRequestBody(type: StartWorkflowRequestBodyTypeField.workflowParameters, flow: StartWorkflowRequestBodyFlowField(type: \"flow\", id: workflowToRun.flows![0].id!), files: [StartWorkflowRequestBodyFilesField(type: StartWorkflowRequestBodyFilesTypeField.file, id: workflowFileId)], folder: StartWorkflowRequestBodyFolderField(type: StartWorkflowRequestBodyFolderTypeField.folder, id: workflowFolderId)))"},{"lang":"java","label":"Starts workflow based on request body","source":"adminClient.getWorkflows().startWorkflow(workflowToRun.getId(), new StartWorkflowRequestBody.Builder(new StartWorkflowRequestBodyFlowField.Builder().type(\"flow\").id(workflowToRun.getFlows().get(0).getId()).build(), Arrays.asList(new StartWorkflowRequestBodyFilesField.Builder().type(StartWorkflowRequestBodyFilesTypeField.FILE).id(workflowFileId).build()), new StartWorkflowRequestBodyFolderField.Builder().type(StartWorkflowRequestBodyFolderTypeField.FOLDER).id(workflowFolderId).build()).type(StartWorkflowRequestBodyTypeField.WORKFLOW_PARAMETERS).build())"},{"lang":"node","label":"Starts workflow based on request body","source":"await adminClient.workflows.startWorkflow(workflowToRun.id!, {\n type: 'workflow_parameters' as StartWorkflowRequestBodyTypeField,\n flow: {\n type: 'flow',\n id: workflowToRun.flows![0].id!,\n } satisfies StartWorkflowRequestBodyFlowField,\n files: [\n {\n type: 'file' as StartWorkflowRequestBodyFilesTypeField,\n id: workflowFileId,\n } satisfies StartWorkflowRequestBodyFilesField,\n ],\n folder: {\n type: 'folder' as StartWorkflowRequestBodyFolderTypeField,\n id: workflowFolderId,\n } satisfies StartWorkflowRequestBodyFolderField,\n} satisfies StartWorkflowRequestBody);"},{"lang":"python","label":"Starts workflow based on request body","source":"admin_client.workflows.start_workflow(\n workflow_to_run.id,\n StartWorkflowFlow(type=\"flow\", id=workflow_to_run.flows[0].id),\n [StartWorkflowFiles(type=StartWorkflowFilesTypeField.FILE, id=workflow_file_id)],\n StartWorkflowFolder(\n type=StartWorkflowFolderTypeField.FOLDER, id=workflow_folder_id\n ),\n type=StartWorkflowType.WORKFLOW_PARAMETERS,\n)"}],"method":"post","type":"path","servers":["1e6b3d1a-c23e-44e4-85dc-9bd42289634f"],"security":["52b044cb-d10f-4fb6-b0c7-e8c7a6aac998"],"path":"/workflows/{workflow_id}/start","baseUrlOptions":["https://api.box.com/2.0"],"title":"Starts workflow based on request body","codeSamples":[{"label":"Starts workflow based on request body","lang":"curl","source":"curl -i -X POST \"https://api.box.com/2.0/workflows/42037322/start\" \\\n -H \"authorization: Bearer \u003cACCESS_TOKEN>\" \\\n -d '{\n \"type\": \"workflow_parameters\",\n \"flow\": {\n \"id\": \"8937625\",\n \"type\": \"flow\"\n },\n \"files\": [{\n \"type\": \"file\",\n \"id\": \"389047572\"\n },\n {\n \"type\": \"file\",\n \"id\": \"389047578\"\n }],\n \"folder\": {\n \"id\": \"2233212\",\n \"type\": \"folder\"\n },\n \"outcomes\": [\n {\n \"id\": \"34895783\",\n \"type\": \"outcome\",\n \"task_collaborators\": {\n \"type\": \"variable\",\n \"variable_type\": \"user_list\",\n \"variable_value\": [{ \"type\": \"user\", \"id\": \"890273642\" }]\n },\n \"completion_rule\": {\n \"type\": \"variable\",\n \"variable_type\": \"task_completion_rule\",\n \"variable_value\": \"all_assignees\"\n },\n \"file_collaborator_role\": {\n \"type\": \"variable\",\n \"variable_type\": \"collaborator_role\",\n \"variable_value\": \"viewer\"\n }\n }\n ]\n }'"},{"label":"Starts workflow based on request body","lang":"dotnet","source":"await adminClient.Workflows.StartWorkflowAsync(workflowId: NullableUtils.Unwrap(workflowToRun.Id), requestBody: new StartWorkflowRequestBody(flow: new StartWorkflowRequestBodyFlowField() { Type = \"flow\", Id = NullableUtils.Unwrap(NullableUtils.Unwrap(workflowToRun.Flows)[0].Id) }, files: Array.AsReadOnly(new [] {new StartWorkflowRequestBodyFilesField() { Type = StartWorkflowRequestBodyFilesTypeField.File, Id = workflowFileId }}), folder: new StartWorkflowRequestBodyFolderField() { Type = StartWorkflowRequestBodyFolderTypeField.Folder, Id = workflowFolderId }) { Type = StartWorkflowRequestBodyTypeField.WorkflowParameters });"},{"label":"Starts workflow based on request body","lang":"swift","source":"try await adminClient.workflows.startWorkflow(workflowId: workflowToRun.id!, requestBody: StartWorkflowRequestBody(type: StartWorkflowRequestBodyTypeField.workflowParameters, flow: StartWorkflowRequestBodyFlowField(type: \"flow\", id: workflowToRun.flows![0].id!), files: [StartWorkflowRequestBodyFilesField(type: StartWorkflowRequestBodyFilesTypeField.file, id: workflowFileId)], folder: StartWorkflowRequestBodyFolderField(type: StartWorkflowRequestBodyFolderTypeField.folder, id: workflowFolderId)))"},{"label":"Starts workflow based on request body","lang":"java","source":"adminClient.getWorkflows().startWorkflow(workflowToRun.getId(), new StartWorkflowRequestBody.Builder(new StartWorkflowRequestBodyFlowField.Builder().type(\"flow\").id(workflowToRun.getFlows().get(0).getId()).build(), Arrays.asList(new StartWorkflowRequestBodyFilesField.Builder().type(StartWorkflowRequestBodyFilesTypeField.FILE).id(workflowFileId).build()), new StartWorkflowRequestBodyFolderField.Builder().type(StartWorkflowRequestBodyFolderTypeField.FOLDER).id(workflowFolderId).build()).type(StartWorkflowRequestBodyTypeField.WORKFLOW_PARAMETERS).build())"},{"label":"Starts workflow based on request body","lang":"node","source":"await adminClient.workflows.startWorkflow(workflowToRun.id!, {\n type: 'workflow_parameters' as StartWorkflowRequestBodyTypeField,\n flow: {\n type: 'flow',\n id: workflowToRun.flows![0].id!,\n } satisfies StartWorkflowRequestBodyFlowField,\n files: [\n {\n type: 'file' as StartWorkflowRequestBodyFilesTypeField,\n id: workflowFileId,\n } satisfies StartWorkflowRequestBodyFilesField,\n ],\n folder: {\n type: 'folder' as StartWorkflowRequestBodyFolderTypeField,\n id: workflowFolderId,\n } satisfies StartWorkflowRequestBodyFolderField,\n} satisfies StartWorkflowRequestBody);"},{"label":"Starts workflow based on request body","lang":"python","source":"admin_client.workflows.start_workflow(\n workflow_to_run.id,\n StartWorkflowFlow(type=\"flow\", id=workflow_to_run.flows[0].id),\n [StartWorkflowFiles(type=StartWorkflowFilesTypeField.FILE, id=workflow_file_id)],\n StartWorkflowFolder(\n type=StartWorkflowFolderTypeField.FOLDER, id=workflow_folder_id\n ),\n type=StartWorkflowType.WORKFLOW_PARAMETERS,\n)"}],"requestExampleLanguages":["bash","python","node","swift","java","dotnet"],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"aa3199a1-39f3-4a44-a982-27e28f0ccdfa":{"name":"workflow_id","in":"path","description":"The ID of the workflow.","required":true,"schema":{"type":"string","isRequired":true,"description":"The ID of the workflow.","uniqueKey":"","typeLabel":"string"},"example":"12345"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"flow":{"description":"The flow that will be triggered.","type":"object","properties":{"type":{"description":"The type of the flow object.","type":"string","example":"flow","uniqueKey":"flow.type","typeLabel":"string"},"id":{"description":"The id of the flow.","type":"string","example":"123456789","uniqueKey":"flow.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"flow","typeLabel":"object"},"files":{"description":"The array of files for which the workflow should start. All files must be in the workflow's configured folder.","type":"array","items":{"type":"object","description":"A file the workflow should start for.","properties":{"type":{"description":"The type of the file object.","type":"string","example":"file","enum":["file"],"uniqueKey":"files.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"description":"The id of the file.","type":"string","example":"12345678","uniqueKey":"files.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"files.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"files","typeLabel":"object[]"},"folder":{"description":"The folder object for which the workflow is configured.","type":"object","properties":{"type":{"description":"The type of the folder object.","type":"string","example":"folder","enum":["folder"],"uniqueKey":"folder.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The id of the folder.","type":"string","example":"87654321","uniqueKey":"folder.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"folder","typeLabel":"object"},"type":{"description":"The type of the parameters object.","type":"string","example":"workflow_parameters","enum":["workflow_parameters"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"outcomes":{"description":"A configurable outcome the workflow should complete.","type":"array","items":{"description":"An instance of an outcome.","type":"object","properties":{"id":{"description":"ID of a specific outcome.","type":"string","example":"17363629","isRequired":true,"uniqueKey":"outcomes.items.[INDEX].id","typeLabel":"string"},"collaborators":{"type":"object","title":"Collaborator variable","description":"Lists collaborators affected by the workflow result.","required":["type","variable_type","variable_value"],"properties":{"type":{"description":"Collaborator object type.","type":"string","example":"variable","enum":["variable"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].collaborators.type","typeLabel":"enum\u003cstring>"},"variable_type":{"description":"Variable type for the Collaborator object.","type":"string","example":"user_list","enum":["user_list"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].collaborators.variable_type","typeLabel":"enum\u003cstring>"},"variable_value":{"description":"A list of user IDs.","type":"array","items":{"type":"object","required":["type","id"],"description":"User variable used in workflow outcomes.","properties":{"type":{"description":"The object type.","type":"string","example":"user","enum":["user"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].collaborators.variable_value.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"description":"User's ID.","type":"string","example":"636281","isRequired":true,"uniqueKey":"outcomes.items.[INDEX].collaborators.variable_value.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"outcomes.items.[INDEX].collaborators.variable_value.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].collaborators.variable_value","typeLabel":"object[]"}},"uniqueKey":"outcomes.items.[INDEX].collaborators","typeLabel":"Collaborator variable · object"},"completion_rule":{"type":"object","title":"Completion rule variable","description":"Determines if an action should be completed by all or any assignees.","required":["type","variable_type","variable_value"],"properties":{"type":{"description":"Completion Rule object type.","type":"string","example":"variable","enum":["variable"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].completion_rule.type","typeLabel":"enum\u003cstring>"},"variable_type":{"description":"Variable type for the Completion Rule object.","type":"string","example":"task_completion_rule","enum":["task_completion_rule"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].completion_rule.variable_type","typeLabel":"enum\u003cstring>"},"variable_value":{"description":"Variable values for a completion rule.","type":"string","example":"all_assignees","enum":["all_assignees","any_assignees"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].completion_rule.variable_value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"outcomes.items.[INDEX].completion_rule","typeLabel":"Completion rule variable · object"},"file_collaborator_role":{"type":"object","title":"Role variable","description":"Determines if the workflow outcome for a file affects a specific collaborator role.","required":["type","variable_type","variable_value"],"properties":{"type":{"description":"Role object type.","type":"string","example":"variable","enum":["variable"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].file_collaborator_role.type","typeLabel":"enum\u003cstring>"},"variable_type":{"description":"The variable type used by the object.","type":"string","example":"collaborator_role","enum":["collaborator_role"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].file_collaborator_role.variable_type","typeLabel":"enum\u003cstring>"},"variable_value":{"type":"string","description":"Variable values you can use for the role parameter.","enum":["editor","viewer","previewer","uploader","previewer uploader","viewer uploader","co-owner"],"example":"editor","isRequired":true,"uniqueKey":"outcomes.items.[INDEX].file_collaborator_role.variable_value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"outcomes.items.[INDEX].file_collaborator_role","typeLabel":"Role variable · object"},"task_collaborators":{"type":"object","title":"Collaborator variable","description":"Lists collaborators affected by the task workflow result.","required":["type","variable_type","variable_value"],"properties":{"type":{"description":"Collaborator object type.","type":"string","example":"variable","enum":["variable"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].task_collaborators.type","typeLabel":"enum\u003cstring>"},"variable_type":{"description":"Variable type for the Collaborator object.","type":"string","example":"user_list","enum":["user_list"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].task_collaborators.variable_type","typeLabel":"enum\u003cstring>"},"variable_value":{"description":"A list of user IDs.","type":"array","items":{"type":"object","required":["type","id"],"description":"User variable used in workflow outcomes.","properties":{"type":{"description":"The object type.","type":"string","example":"user","enum":["user"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].task_collaborators.variable_value.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"description":"User's ID.","type":"string","example":"636281","isRequired":true,"uniqueKey":"outcomes.items.[INDEX].task_collaborators.variable_value.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"outcomes.items.[INDEX].task_collaborators.variable_value.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].task_collaborators.variable_value","typeLabel":"object[]"}},"uniqueKey":"outcomes.items.[INDEX].task_collaborators","typeLabel":"Collaborator variable · object"},"role":{"type":"object","title":"Role variable","description":"Determines if the workflow outcome affects a specific collaborator role.","required":["type","variable_type","variable_value"],"properties":{"type":{"description":"Role object type.","type":"string","example":"variable","enum":["variable"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].role.type","typeLabel":"enum\u003cstring>"},"variable_type":{"description":"The variable type used by the object.","type":"string","example":"collaborator_role","enum":["collaborator_role"],"isRequired":true,"uniqueKey":"outcomes.items.[INDEX].role.variable_type","typeLabel":"enum\u003cstring>"},"variable_value":{"type":"string","description":"Variable values you can use for the role parameter.","enum":["editor","viewer","previewer","uploader","previewer uploader","viewer uploader","co-owner"],"example":"editor","isRequired":true,"uniqueKey":"outcomes.items.[INDEX].role.variable_value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"outcomes.items.[INDEX].role","typeLabel":"Role variable · object"}},"required":["id"],"title":"Outcome","uniqueKey":"outcomes.items.[INDEX]","typeLabel":"Outcome · object"},"uniqueKey":"outcomes","typeLabel":"Outcome · object[]"}},"required":["flow","files","folder"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"flow":{"type":"flow","id":"123456789"},"files":[{"type":"file","id":"12345678"}],"folder":{"type":"folder","id":"87654321"},"type":"workflow_parameters","outcomes":[{"id":"17363629"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"54176268-b7cc-46a1-9b17-b965b4cb8824":{"description":"Starts the workflow.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ca421ebf-d83e-47e3-9f13-42288fdf0c68":{"description":"Returns an error if some of the parameters are missing or not valid.\n\n- `workflow_is_not_enabled` when the workflow is not enabled.\n- `workflow_not_active_on_provided_folder` when the workflow is not enabled for the specified folder id.\n- `parameters_provided_do_not_match_target_outcome` when the provided parameters do not match the expected parameters.","content":{"application/json":{"schema":{"description":"A generic error.","type":"object","properties":{"type":{"description":"The value will always be `error`.","type":"string","example":"error","enum":["error"],"nullable":false,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"The HTTP status of the response.","type":"integer","format":"int32","example":400,"nullable":false,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"code":{"description":"A Box-specific error code.","type":"string","example":"item_name_invalid","enum":["created","accepted","no_content","redirect","not_modified","bad_request","unauthorized","forbidden","not_found","method_not_allowed","conflict","precondition_failed","unprocessable_entity","too_many_requests","internal_server_error","unavailable","item_name_invalid","insufficient_scope"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"description":"A short message describing the error.","type":"string","example":"Method Not Allowed","nullable":false,"uniqueKey":"message","typeLabel":"string"},"context_info":{"oneOf":[{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"object","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.0","typeLabel":"object"},{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"null","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"context_info","typeLabel":"object | null"},"help_url":{"description":"A URL that links to more information about why this error occurred.","type":"string","example":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","nullable":false,"uniqueKey":"help_url","typeLabel":"string"},"request_id":{"description":"A unique identifier for this response, which can be used when contacting Box support.","type":"string","example":"abcdef123456","nullable":false,"uniqueKey":"request_id","typeLabel":"string"}},"title":"Client error","x-box-resource-id":"client_error","uniqueKey":"","typeLabel":"Client error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","status":400,"code":"item_name_invalid","message":"Method Not Allowed","context_info":{"message":"Something went wrong"},"help_url":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","request_id":"abcdef123456"}}},"exampleType":"generated"}},"exampleType":"generated"},"da75a7e2-f825-4f1c-ac96-1623f3569fb2":{"description":"Returns an error if there are insufficient permissions.\n\n- `insufficient_access` when the user does not have access rights to file or folder.\n- `missing_relay_full_access` when the user does not have access to Relay Full.","content":{"application/json":{"schema":{"description":"A generic error.","type":"object","properties":{"type":{"description":"The value will always be `error`.","type":"string","example":"error","enum":["error"],"nullable":false,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"The HTTP status of the response.","type":"integer","format":"int32","example":400,"nullable":false,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"code":{"description":"A Box-specific error code.","type":"string","example":"item_name_invalid","enum":["created","accepted","no_content","redirect","not_modified","bad_request","unauthorized","forbidden","not_found","method_not_allowed","conflict","precondition_failed","unprocessable_entity","too_many_requests","internal_server_error","unavailable","item_name_invalid","insufficient_scope"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"description":"A short message describing the error.","type":"string","example":"Method Not Allowed","nullable":false,"uniqueKey":"message","typeLabel":"string"},"context_info":{"oneOf":[{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"object","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.0","typeLabel":"object"},{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"null","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"context_info","typeLabel":"object | null"},"help_url":{"description":"A URL that links to more information about why this error occurred.","type":"string","example":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","nullable":false,"uniqueKey":"help_url","typeLabel":"string"},"request_id":{"description":"A unique identifier for this response, which can be used when contacting Box support.","type":"string","example":"abcdef123456","nullable":false,"uniqueKey":"request_id","typeLabel":"string"}},"title":"Client error","x-box-resource-id":"client_error","uniqueKey":"","typeLabel":"Client error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","status":400,"code":"item_name_invalid","message":"Method Not Allowed","context_info":{"message":"Something went wrong"},"help_url":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","request_id":"abcdef123456"}}},"exampleType":"generated"}},"exampleType":"generated"},"1c1bb587-05d8-49f3-b535-03cc303f4c4b":{"description":"Returns an error if the workflow could not be found, or the authenticated user does not have access to the workflow.\n\n- `workflow_not_found` when the workflow is not found.\n- `flow_missing_or_inaccessible` when the flow is not a manual start flow.","content":{"application/json":{"schema":{"description":"A generic error.","type":"object","properties":{"type":{"description":"The value will always be `error`.","type":"string","example":"error","enum":["error"],"nullable":false,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"The HTTP status of the response.","type":"integer","format":"int32","example":400,"nullable":false,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"code":{"description":"A Box-specific error code.","type":"string","example":"item_name_invalid","enum":["created","accepted","no_content","redirect","not_modified","bad_request","unauthorized","forbidden","not_found","method_not_allowed","conflict","precondition_failed","unprocessable_entity","too_many_requests","internal_server_error","unavailable","item_name_invalid","insufficient_scope"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"description":"A short message describing the error.","type":"string","example":"Method Not Allowed","nullable":false,"uniqueKey":"message","typeLabel":"string"},"context_info":{"oneOf":[{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"object","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.0","typeLabel":"object"},{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"null","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"context_info","typeLabel":"object | null"},"help_url":{"description":"A URL that links to more information about why this error occurred.","type":"string","example":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","nullable":false,"uniqueKey":"help_url","typeLabel":"string"},"request_id":{"description":"A unique identifier for this response, which can be used when contacting Box support.","type":"string","example":"abcdef123456","nullable":false,"uniqueKey":"request_id","typeLabel":"string"}},"title":"Client error","x-box-resource-id":"client_error","uniqueKey":"","typeLabel":"Client error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","status":400,"code":"item_name_invalid","message":"Method Not Allowed","context_info":{"message":"Something went wrong"},"help_url":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","request_id":"abcdef123456"}}},"exampleType":"generated"}},"exampleType":"generated"},"1cde97c3-29de-4632-a51d-fcf09675ceee":{"description":"An unexpected client error.","content":{"application/json":{"schema":{"description":"A generic error.","type":"object","properties":{"type":{"description":"The value will always be `error`.","type":"string","example":"error","enum":["error"],"nullable":false,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"The HTTP status of the response.","type":"integer","format":"int32","example":400,"nullable":false,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"code":{"description":"A Box-specific error code.","type":"string","example":"item_name_invalid","enum":["created","accepted","no_content","redirect","not_modified","bad_request","unauthorized","forbidden","not_found","method_not_allowed","conflict","precondition_failed","unprocessable_entity","too_many_requests","internal_server_error","unavailable","item_name_invalid","insufficient_scope"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"description":"A short message describing the error.","type":"string","example":"Method Not Allowed","nullable":false,"uniqueKey":"message","typeLabel":"string"},"context_info":{"oneOf":[{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"object","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.0","typeLabel":"object"},{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"null","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"context_info","typeLabel":"object | null"},"help_url":{"description":"A URL that links to more information about why this error occurred.","type":"string","example":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","nullable":false,"uniqueKey":"help_url","typeLabel":"string"},"request_id":{"description":"A unique identifier for this response, which can be used when contacting Box support.","type":"string","example":"abcdef123456","nullable":false,"uniqueKey":"request_id","typeLabel":"string"}},"title":"Client error","x-box-resource-id":"client_error","uniqueKey":"","typeLabel":"Client error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","status":400,"code":"item_name_invalid","message":"Method Not Allowed","context_info":{"message":"Something went wrong"},"help_url":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","request_id":"abcdef123456"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"52b044cb-d10f-4fb6-b0c7-e8c7a6aac998":{"OAuth2Security":{"type":"oauth2","description":"The access token received from the authorization server in the OAuth 2.0 flow.","flows":{"authorizationCode":{"authorizationUrl":"https://account.box.com/api/oauth2/authorize","tokenUrl":"https://api.box.com/oauth2/token","scopes":{"root_readonly":"Read all files and folders stored in Box","root_readwrite":"Read and write all files and folders stored in Box","manage_app_users":"Provision and manage app users","manage_managed_users":"Provision and manage managed users","manage_groups":"Manage an enterprise's groups","manage_webhook":"Create webhooks programmatically through the API","manage_enterprise_properties":"Manage enterprise properties","manage_data_retention":"Manage data retention polices","manage_legal_hold":"Manage Legal Holds"}}},"scopes":[],"schemeName":"OAuth2Security"}}},"servers":{"1e6b3d1a-c23e-44e4-85dc-9bd42289634f":{"url":"https://api.box.com/2.0","description":"Box Platform API server."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"The access token received from the authorization server in the OAuth 2.0 flow.","flows":{"authorizationCode":{"authorizationUrl":"https://account.box.com/api/oauth2/authorize","tokenUrl":"https://api.box.com/oauth2/token","scopes":{"root_readonly":"Read all files and folders stored in Box","root_readwrite":"Read and write all files and folders stored in Box","manage_app_users":"Provision and manage app users","manage_managed_users":"Provision and manage managed users","manage_groups":"Manage an enterprise's groups","manage_webhook":"Create webhooks programmatically through the API","manage_enterprise_properties":"Manage enterprise properties","manage_data_retention":"Manage data retention polices","manage_legal_hold":"Manage Legal Holds"}}},"scopes":[],"schemeName":"OAuth2Security"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2Security","name":"Authorization"}],"title":"OAuth2Security"}]},"originalFileLocation":"box-openapi.json"},"subdomain":"box","siteName":"Box Dev Docs","title":"Starts workflow based on request body - Box Dev Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/post-workflows-id-start","matchLevel":0},"ja":{"href":"/ja/reference/post-workflows-id-start","matchLevel":1}}},"lastModified":"2026-03-25T11:58:00.271Z","gitLastModified":"2026-01-23T14:40:02.000Z","originalFileLocation":"reference/post-workflows-id-start.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=\"Initiates a flow with a trigger type of WORKFLOW_MANUAL_START. You application must be authorized to use the Manage Box Relay application scope within the developer console.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Box Dev Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_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/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Starts workflow based on request body - Box Dev Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initiates a flow with a trigger type of WORKFLOW_MANUAL_START. You application must be authorized to use the Manage Box Relay application scope within the developer console.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Box Dev Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.box.com/reference/post-workflows-id-start\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://box.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Starts+workflow+based+on+request+body\u0026amp;description=Initiates+a+flow+with+a+trigger+type+of+%60WORKFLOW_MANUAL_START%60.%0A%0AYou+application+must+be+authorized+to+use+the+%60Manage+Box+Relay%60+application+scope+within+the+\u0026amp;theme=7c006b8b877970d319badcf9\u0026amp;signature=e2b859d6af77a8fdd308acd6129023971d1dcefff75d3d7eb2def3e31e5ffc62\">\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=\"Starts workflow based on request body - Box Dev Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initiates a flow with a trigger type of WORKFLOW_MANUAL_START. You application must be authorized to use the Manage Box Relay application scope within the developer console.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://box.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Starts+workflow+based+on+request+body\u0026amp;description=Initiates+a+flow+with+a+trigger+type+of+%60WORKFLOW_MANUAL_START%60.%0A%0AYou+application+must+be+authorized+to+use+the+%60Manage+Box+Relay%60+application+scope+within+the+\u0026amp;theme=7c006b8b877970d319badcf9\u0026amp;signature=e2b859d6af77a8fdd308acd6129023971d1dcefff75d3d7eb2def3e31e5ffc62\">\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/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Box Dev Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0061d5\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"fuelbNhVR1kQluNBJjYt4K1Hj5HvJLhLnIq0o9CAY9E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.box.com/reference/post-workflows-id-start\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/post-workflows-id-start.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developer.box.com/reference/post-workflows-id-start\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://developer.box.com/ja/reference/post-workflows-id-start\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developer.box.com/reference/post-workflows-id-start\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.box.com/#organization\",\"name\":\"Box Dev Docs\",\"url\":\"https://developer.box.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/box/lJLw9z7FWORNWMcq/logo/boxdev-light.png?fit=max\u0026auto=format\u0026n=lJLw9z7FWORNWMcq\u0026q=85\u0026s=a11710b698ff59d24426f9ecec6c7e9c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.box.com#website\",\"name\":\"Box Dev Docs\",\"url\":\"https://developer.box.com\",\"publisher\":{\"@id\":\"https://developer.box.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.box.com/reference/post-workflows-id-start#webpage\",\"url\":\"https://developer.box.com/reference/post-workflows-id-start\",\"name\":\"Starts workflow based on request body\",\"description\":\"Initiates a flow with a trigger type of WORKFLOW_MANUAL_START. You application must be authorized to use the Manage Box Relay application scope within the developer console.\",\"dateModified\":\"2026-01-23T14:40:02.000Z\",\"isPartOf\":{\"@id\":\"https://developer.box.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.box.com/reference/post-workflows-id-start#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.box.com/reference/post-workflows-id-start#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://developer.box.com/reference/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows\",\"item\":\"https://developer.box.com/reference/workflows-resources\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Starts workflow based on request body\",\"item\":\"https://developer.box.com/reference/post-workflows-id-start\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.box.com/reference/post-workflows-id-start#apireference\",\"headline\":\"Starts workflow based on request body\",\"name\":\"Starts workflow based on request body\",\"description\":\"Initiates a flow with a trigger type of WORKFLOW_MANUAL_START. You application must be authorized to use the Manage Box Relay application scope within the developer console.\",\"url\":\"https://developer.box.com/reference/post-workflows-id-start\",\"mainEntityOfPage\":{\"@id\":\"https://developer.box.com/reference/post-workflows-id-start#webpage\"},\"dateModified\":\"2026-01-23T14:40:02.000Z\",\"publisher\":{\"@id\":\"https://developer.box.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.box.com#website\"}}]}\u003c/script>","siteName":"Box Dev Docs","nav":{"global":null,"languages":[{"language":"en","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"Resources","items":[{"label":"Newsletter unsubscribe","href":"https://go.box.com/preferences.html"},{"label":"Terms of Use","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"Privacy Policy","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookie Notification","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"Log in","type":"button"}],"primary":{"type":"button","label":"Get started for free","href":"https://account.box.com/signup/developer"}},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai"}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/reference"},{"group":"AI","root":{"title":"AI resources","href":"/reference/ai-resources"},"pages":[{"title":"Get AI agent default configuration","openapi":"box-openapi.json GET /ai_agent_default","href":"/reference/get-ai-agent-default"},{"title":"Ask question","openapi":"box-openapi.json POST /ai/ask","href":"/reference/post-ai-ask"},{"title":"Extract metadata (freeform)","openapi":"box-openapi.json POST /ai/extract","href":"/reference/post-ai-extract"},{"title":"Extract metadata (structured)","openapi":"box-openapi.json POST /ai/extract_structured","href":"/reference/post-ai-extract-structured"},{"title":"Generate text","openapi":"box-openapi.json POST /ai/text_gen","href":"/reference/post-ai-text-gen"}]},{"group":"AI Studio","root":{"title":"AI Studio resources","href":"/reference/ai-studio-resources"},"pages":[{"title":"Get AI agent by agent ID","openapi":"box-openapi.json GET /ai_agents/{agent_id}","href":"/reference/get-ai-agents-id"},{"title":"List AI agents","openapi":"box-openapi.json GET /ai_agents","href":"/reference/get-ai-agents"},{"title":"Create AI agent","openapi":"box-openapi.json POST /ai_agents","href":"/reference/post-ai-agents"},{"title":"Update AI agent","openapi":"box-openapi.json PUT /ai_agents/{agent_id}","href":"/reference/put-ai-agents-id"},{"title":"Delete AI agent","openapi":"box-openapi.json DELETE /ai_agents/{agent_id}","href":"/reference/delete-ai-agents-id"}]},{"group":"App item associations","root":{"title":"App item associations resources","href":"/reference/app-item-associations-resources"},"pages":[{"title":"List file app item associations","openapi":"box-openapi.json GET /files/{file_id}/app_item_associations","href":"/reference/get-files-id-app-item-associations"},{"title":"List folder app item associations","openapi":"box-openapi.json GET /folders/{folder_id}/app_item_associations","href":"/reference/get-folders-id-app-item-associations"}]},{"group":"Authorization","root":{"title":"Authorization resources","href":"/reference/authorization-resources"},"pages":[{"title":"Authorize user","openapi":"box-openapi.json GET /authorize","href":"/reference/get-authorize"},{"title":"Refresh access token","openapi":"box-openapi.json POST /oauth2/token#refresh","href":"/reference/post-oauth2-token--refresh"},{"title":"Request access token","openapi":"box-openapi.json POST /oauth2/token","href":"/reference/post-oauth2-token"},{"title":"Revoke access token","openapi":"box-openapi.json POST /oauth2/revoke","href":"/reference/post-oauth2-revoke"}]},{"group":"Box Sign requests","root":{"title":"Box Sign requests resources","href":"/reference/sign-requests-resources"},"pages":[{"title":"Get Box Sign request by ID","openapi":"box-openapi.json GET /sign_requests/{sign_request_id}","href":"/reference/get-sign-requests-id"},{"title":"List Box Sign requests","openapi":"box-openapi.json GET /sign_requests","href":"/reference/get-sign-requests"},{"title":"Cancel Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/cancel","href":"/reference/post-sign-requests-id-cancel"},{"title":"Create Box Sign request","openapi":"box-openapi.json POST /sign_requests","href":"/reference/post-sign-requests"},{"title":"Resend Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/resend","href":"/reference/post-sign-requests-id-resend"}]},{"group":"Box Sign templates","root":{"title":"Box Sign templates resources","href":"/reference/sign-templates-resources"},"pages":[{"title":"Get Box Sign template by ID","openapi":"box-openapi.json GET /sign_templates/{template_id}","href":"/reference/get-sign-templates-id"},{"title":"List Box Sign templates","openapi":"box-openapi.json GET /sign_templates","href":"/reference/get-sign-templates"}]},{"group":"Classifications","root":{"title":"Classifications resources","href":"/reference/classifications-resources"},"pages":[{"title":"List all classifications","openapi":"box-openapi.json GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","href":"/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},{"title":"Add initial classifications","openapi":"box-openapi.json POST /metadata_templates/schema#classifications","href":"/reference/post-metadata-templates-schema--classifications"},{"title":"Add classification","openapi":"box-openapi.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add","href":"/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add"},{"title":"Update classification","openapi":"box-openapi.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update","href":"/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update"}]},{"group":"Classifications on files","pages":[{"title":"Get classification on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Add classification to file","openapi":"box-openapi.json POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Update classification on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Remove classification from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"Classifications on folders","pages":[{"title":"Get classification on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Add classification to folder","openapi":"box-openapi.json POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Update classification on folder","openapi":"box-openapi.json PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Remove classification from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","href":"/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"Collaborations","root":{"title":"Collaborations resources","href":"/reference/user-collaborations-resources"},"pages":[{"title":"Get collaboration","openapi":"box-openapi.json GET /collaborations/{collaboration_id}","href":"/reference/get-collaborations-id"},{"title":"Create collaboration","openapi":"box-openapi.json POST /collaborations","href":"/reference/post-collaborations"},{"title":"Update collaboration","openapi":"box-openapi.json PUT /collaborations/{collaboration_id}","href":"/reference/put-collaborations-id"},{"title":"Remove collaboration","openapi":"box-openapi.json DELETE /collaborations/{collaboration_id}","href":"/reference/delete-collaborations-id"}]},{"group":"Collaborations (List)","pages":[{"title":"List file collaborations","openapi":"box-openapi.json GET /files/{file_id}/collaborations","href":"/reference/get-files-id-collaborations"},{"title":"List folder collaborations","openapi":"box-openapi.json GET /folders/{folder_id}/collaborations","href":"/reference/get-folders-id-collaborations"},{"title":"List group collaborations","openapi":"box-openapi.json GET /groups/{group_id}/collaborations","href":"/reference/get-groups-id-collaborations"},{"title":"List pending collaborations","openapi":"box-openapi.json GET /collaborations","href":"/reference/get-collaborations"}]},{"group":"Collections","root":{"title":"Collections resources","href":"/reference/collections-resources"},"pages":[{"title":"Get collection by ID","openapi":"box-openapi.json GET /collections/{collection_id}","href":"/reference/get-collections-id"},{"title":"List all collections","openapi":"box-openapi.json GET /collections","href":"/reference/get-collections"},{"title":"List collection items","openapi":"box-openapi.json GET /collections/{collection_id}/items","href":"/reference/get-collections-id-items"}]},{"group":"Comments","root":{"title":"Comments resources","href":"/reference/comments-resources"},"pages":[{"title":"Get comment","openapi":"box-openapi.json GET /comments/{comment_id}","href":"/reference/get-comments-id"},{"title":"List file comments","openapi":"box-openapi.json GET /files/{file_id}/comments","href":"/reference/get-files-id-comments"},{"title":"Create comment","openapi":"box-openapi.json POST /comments","href":"/reference/post-comments"},{"title":"Update comment","openapi":"box-openapi.json PUT /comments/{comment_id}","href":"/reference/put-comments-id"},{"title":"Remove comment","openapi":"box-openapi.json DELETE /comments/{comment_id}","href":"/reference/delete-comments-id"}]},{"group":"Device pinners","root":{"title":"Device pinners resources","href":"/reference/device-pinners-resources"},"pages":[{"title":"Get device pin","openapi":"box-openapi.json GET /device_pinners/{device_pinner_id}","href":"/reference/get-device-pinners-id"},{"title":"List enterprise device pins","openapi":"box-openapi.json GET /enterprises/{enterprise_id}/device_pinners","href":"/reference/get-enterprises-id-device-pinners"},{"title":"Remove device pin","openapi":"box-openapi.json DELETE /device_pinners/{device_pinner_id}","href":"/reference/delete-device-pinners-id"}]},{"group":"Domain restrictions (User exemptions)","root":{"title":"Domain restrictions (User exemptions) resources","href":"/reference/collaboration-allowlist-exempt-targets-resources"},"pages":[{"title":"Get user exempt from collaboration domain restrictions","openapi":"box-openapi.json GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","href":"/reference/get-collaboration-whitelist-exempt-targets-id"},{"title":"List users exempt from collaboration domain restrictions","openapi":"box-openapi.json GET /collaboration_whitelist_exempt_targets","href":"/reference/get-collaboration-whitelist-exempt-targets"},{"title":"Create user exemption from collaboration domain restrictions","openapi":"box-openapi.json POST /collaboration_whitelist_exempt_targets","href":"/reference/post-collaboration-whitelist-exempt-targets"},{"title":"Remove user from list of users exempt from domain restrictions","openapi":"box-openapi.json DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","href":"/reference/delete-collaboration-whitelist-exempt-targets-id"}]},{"group":"Domain restrictions for collaborations","root":{"title":"Domain restrictions for collaborations resources","href":"/reference/collaboration-allowlist-entries-resources"},"pages":[{"title":"Get allowed collaboration domain","openapi":"box-openapi.json GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","href":"/reference/get-collaboration-whitelist-entries-id"},{"title":"List allowed collaboration domains","openapi":"box-openapi.json GET /collaboration_whitelist_entries","href":"/reference/get-collaboration-whitelist-entries"},{"title":"Add domain to list of allowed collaboration domains","openapi":"box-openapi.json POST /collaboration_whitelist_entries","href":"/reference/post-collaboration-whitelist-entries"},{"title":"Remove domain from list of allowed collaboration domains","openapi":"box-openapi.json DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","href":"/reference/delete-collaboration-whitelist-entries-id"}]},{"group":"Downloads","pages":[{"title":"Download file","openapi":"box-openapi.json GET /files/{file_id}/content","href":"/reference/get-files-id-content"}]},{"group":"Email aliases","root":{"title":"Email aliases resources","href":"/reference/email-aliases-resources"},"pages":[{"title":"List user's email aliases","openapi":"box-openapi.json GET /users/{user_id}/email_aliases","href":"/reference/get-users-id-email-aliases"},{"title":"Create email alias","openapi":"box-openapi.json POST /users/{user_id}/email_aliases","href":"/reference/post-users-id-email-aliases"},{"title":"Remove email alias","openapi":"box-openapi.json DELETE /users/{user_id}/email_aliases/{email_alias_id}","href":"/reference/delete-users-id-email-aliases-id"}]},{"group":"Events","root":{"title":"Events resources","href":"/reference/events-resources"},"pages":[{"title":"List user and enterprise events","openapi":"box-openapi.json GET /events","href":"/reference/get-events"},{"title":"Get events long poll endpoint","openapi":"/box-openapi.json OPTIONS /events","href":"/reference/options-events"}]},{"group":"File requests","root":{"title":"File requests resources","href":"/reference/file-requests-resources"},"pages":[{"title":"Get file request","openapi":"box-openapi.json GET /file_requests/{file_request_id}","href":"/reference/get-file-requests-id"},{"title":"Copy file request","openapi":"box-openapi.json POST /file_requests/{file_request_id}/copy","href":"/reference/post-file-requests-id-copy"},{"title":"Update file request","openapi":"box-openapi.json PUT /file_requests/{file_request_id}","href":"/reference/put-file-requests-id"},{"title":"Delete file request","openapi":"box-openapi.json DELETE /file_requests/{file_request_id}","href":"/reference/delete-file-requests-id"}]},{"group":"File version legal holds","root":{"title":"File version legal holds resources","href":"/reference/file-version-legal-holds-resources"},"pages":[{"title":"Get file version legal hold","openapi":"box-openapi.json GET /file_version_legal_holds/{file_version_legal_hold_id}","href":"/reference/get-file-version-legal-holds-id"},{"title":"List file version legal holds","openapi":"box-openapi.json GET /file_version_legal_holds","href":"/reference/get-file-version-legal-holds"}]},{"group":"File version retentions","root":{"title":"File version retentions resources","href":"/reference/file-version-retentions-resources"},"pages":[{"title":"Get retention on file","openapi":"box-openapi.json GET /file_version_retentions/{file_version_retention_id}","href":"/reference/get-file-version-retentions-id"},{"title":"List file version retentions","openapi":"box-openapi.json GET /file_version_retentions","href":"/reference/get-file-version-retentions"}]},{"group":"File versions","root":{"title":"File versions resources","href":"/reference/file-versions-resources"},"pages":[{"title":"Get file version","openapi":"box-openapi.json GET /files/{file_id}/versions/{file_version_id}","href":"/reference/get-files-id-versions-id"},{"title":"List all file versions","openapi":"box-openapi.json GET /files/{file_id}/versions","href":"/reference/get-files-id-versions"},{"title":"Promote file version","openapi":"box-openapi.json POST /files/{file_id}/versions/current","href":"/reference/post-files-id-versions-current"},{"title":"Restore file version","openapi":"box-openapi.json PUT /files/{file_id}/versions/{file_version_id}","href":"/reference/put-files-id-versions-id"},{"title":"Remove file version","openapi":"box-openapi.json DELETE /files/{file_id}/versions/{file_version_id}","href":"/reference/delete-files-id-versions-id"}]},{"group":"Files","root":{"title":"Files resources","href":"/reference/files-resources"},"pages":[{"title":"Get file information","openapi":"box-openapi.json GET /files/{file_id}","href":"/reference/get-files-id"},{"title":"Get file thumbnail","openapi":"box-openapi.json GET /files/{file_id}/thumbnail.{extension}","href":"/reference/get-files-id-thumbnail-id"},{"title":"Copy file","openapi":"box-openapi.json POST /files/{file_id}/copy","href":"/reference/post-files-id-copy"},{"title":"Update file","openapi":"box-openapi.json PUT /files/{file_id}","href":"/reference/put-files-id"},{"title":"Delete file","openapi":"box-openapi.json DELETE /files/{file_id}","href":"/reference/delete-files-id"}]},{"group":"Folder Locks","root":{"title":"Folder Locks resources","href":"/reference/folder-locks-resources"},"pages":[{"title":"List folder locks","openapi":"box-openapi.json GET /folder_locks","href":"/reference/get-folder-locks"},{"title":"Create folder lock","openapi":"box-openapi.json POST /folder_locks","href":"/reference/post-folder-locks"},{"title":"Delete folder lock","openapi":"box-openapi.json DELETE /folder_locks/{folder_lock_id}","href":"/reference/delete-folder-locks-id"}]},{"group":"Folders","root":{"title":"Folders resources","href":"/reference/folders-resources"},"pages":[{"title":"Get folder information","openapi":"box-openapi.json GET /folders/{folder_id}","href":"/reference/get-folders-id"},{"title":"List items in folder","openapi":"box-openapi.json GET /folders/{folder_id}/items","href":"/reference/get-folders-id-items"},{"title":"Copy folder","openapi":"box-openapi.json POST /folders/{folder_id}/copy","href":"/reference/post-folders-id-copy"},{"title":"Create folder","openapi":"box-openapi.json POST /folders","href":"/reference/post-folders"},{"title":"Update folder","openapi":"box-openapi.json PUT /folders/{folder_id}","href":"/reference/put-folders-id"},{"title":"Delete folder","openapi":"box-openapi.json DELETE /folders/{folder_id}","href":"/reference/delete-folders-id"}]},{"group":"Group memberships","root":{"title":"Group memberships resources","href":"/reference/memberships-resources"},"pages":[{"title":"Get group membership","openapi":"box-openapi.json GET /group_memberships/{group_membership_id}","href":"/reference/get-group-memberships-id"},{"title":"List members of group","openapi":"box-openapi.json GET /groups/{group_id}/memberships","href":"/reference/get-groups-id-memberships"},{"title":"List user's groups","openapi":"box-openapi.json GET /users/{user_id}/memberships","href":"/reference/get-users-id-memberships"},{"title":"Add user to group","openapi":"box-openapi.json POST /group_memberships","href":"/reference/post-group-memberships"},{"title":"Update group membership","openapi":"box-openapi.json PUT /group_memberships/{group_membership_id}","href":"/reference/put-group-memberships-id"},{"title":"Remove user from group","openapi":"box-openapi.json DELETE /group_memberships/{group_membership_id}","href":"/reference/delete-group-memberships-id"}]},{"group":"Groups","root":{"title":"Groups resources","href":"/reference/groups-resources"},"pages":[{"title":"Get group","openapi":"box-openapi.json GET /groups/{group_id}","href":"/reference/get-groups-id"},{"title":"List groups for enterprise","openapi":"box-openapi.json GET /groups","href":"/reference/get-groups"},{"title":"Create group","openapi":"box-openapi.json POST /groups","href":"/reference/post-groups"},{"title":"Update group","openapi":"box-openapi.json PUT /groups/{group_id}","href":"/reference/put-groups-id"},{"title":"Remove group","openapi":"box-openapi.json DELETE /groups/{group_id}","href":"/reference/delete-groups-id"}]},{"group":"Integration mappings","root":{"title":"Integration mappings resources","href":"/reference/integration-mappings-resources"},"pages":[{"title":"List Slack integration mappings","openapi":"box-openapi.json GET /integration_mappings/slack","href":"/reference/get-integration-mappings-slack"},{"title":"List Teams integration mappings","openapi":"box-openapi.json GET /integration_mappings/teams","href":"/reference/get-integration-mappings-teams"},{"title":"Create Slack integration mapping","openapi":"box-openapi.json POST /integration_mappings/slack","href":"/reference/post-integration-mappings-slack"},{"title":"Create Teams integration mapping","openapi":"box-openapi.json POST /integration_mappings/teams","href":"/reference/post-integration-mappings-teams"},{"title":"Update Slack integration mapping","openapi":"box-openapi.json PUT /integration_mappings/slack/{integration_mapping_id}","href":"/reference/put-integration-mappings-slack-id"},{"title":"Update Teams integration mapping","openapi":"box-openapi.json PUT /integration_mappings/teams/{integration_mapping_id}","href":"/reference/put-integration-mappings-teams-id"},{"title":"Delete Slack integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/slack/{integration_mapping_id}","href":"/reference/delete-integration-mappings-slack-id"},{"title":"Delete Teams integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/teams/{integration_mapping_id}","href":"/reference/delete-integration-mappings-teams-id"}]},{"group":"Invites","root":{"title":"Invites resources","href":"/reference/invites-resources"},"pages":[{"title":"Get user invite status","openapi":"box-openapi.json GET /invites/{invite_id}","href":"/reference/get-invites-id"},{"title":"Create user invite","openapi":"box-openapi.json POST /invites","href":"/reference/post-invites"}]},{"group":"Legal hold policies","root":{"title":"Legal hold policies resources","href":"/reference/legal-hold-policies-resources"},"pages":[{"title":"Get legal hold policy","openapi":"box-openapi.json GET /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/get-legal-hold-policies-id"},{"title":"List all legal hold policies","openapi":"box-openapi.json GET /legal_hold_policies","href":"/reference/get-legal-hold-policies"},{"title":"Create legal hold policy","openapi":"box-openapi.json POST /legal_hold_policies","href":"/reference/post-legal-hold-policies"},{"title":"Update legal hold policy","openapi":"box-openapi.json PUT /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/put-legal-hold-policies-id"},{"title":"Remove legal hold policy","openapi":"box-openapi.json DELETE /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/delete-legal-hold-policies-id"}]},{"group":"Legal hold policy assignments","root":{"title":"Legal hold policy assignments resources","href":"/reference/legal-hold-policy-assignments-resources"},"pages":[{"title":"Get legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","href":"/reference/get-legal-hold-policy-assignments-id"},{"title":"List files with current file versions for legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold","href":"/reference/get-legal-hold-policy-assignments-id-files-on-hold"},{"title":"List legal hold policy assignments","openapi":"box-openapi.json GET /legal_hold_policy_assignments","href":"/reference/get-legal-hold-policy-assignments"},{"title":"List previous file versions for legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold","href":"/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold"},{"title":"Assign legal hold policy","openapi":"box-openapi.json POST /legal_hold_policy_assignments","href":"/reference/post-legal-hold-policy-assignments"},{"title":"Unassign legal hold policy","openapi":"box-openapi.json DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","href":"/reference/delete-legal-hold-policy-assignments-id"}]},{"group":"Metadata cascade policies","root":{"title":"Metadata cascade policies resources","href":"/reference/metadata-cascade-policies-resources"},"pages":[{"title":"Get metadata cascade policy","openapi":"box-openapi.json GET /metadata_cascade_policies/{metadata_cascade_policy_id}","href":"/reference/get-metadata-cascade-policies-id"},{"title":"List metadata cascade policies","openapi":"box-openapi.json GET /metadata_cascade_policies","href":"/reference/get-metadata-cascade-policies"},{"title":"Create metadata cascade policy","openapi":"box-openapi.json POST /metadata_cascade_policies","href":"/reference/post-metadata-cascade-policies"},{"title":"Force-apply metadata cascade policy to folder","openapi":"box-openapi.json POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply","href":"/reference/post-metadata-cascade-policies-id-apply"},{"title":"Remove metadata cascade policy","openapi":"box-openapi.json DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}","href":"/reference/delete-metadata-cascade-policies-id"}]},{"group":"Metadata instances (Files)","root":{"title":"Metadata instances (Files) resources","href":"/reference/file-metadata-resources"},"pages":[{"title":"Get metadata instance on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/{scope}/{template_key}","href":"/reference/get-files-id-metadata-id-id"},{"title":"List metadata instances on file","openapi":"box-openapi.json GET /files/{file_id}/metadata","href":"/reference/get-files-id-metadata"},{"title":"Create metadata instance on file","openapi":"box-openapi.json POST /files/{file_id}/metadata/{scope}/{template_key}","href":"/reference/post-files-id-metadata-id-id"},{"title":"Update metadata instance on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/{scope}/{template_key}","href":"/reference/put-files-id-metadata-id-id"},{"title":"Remove metadata instance from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/{scope}/{template_key}","href":"/reference/delete-files-id-metadata-id-id"}]},{"group":"Metadata instances (Folders)","pages":[{"title":"Get metadata instance on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata/{scope}/{template_key}","href":"/reference/get-folders-id-metadata-id-id"},{"title":"List metadata instances on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata","href":"/reference/get-folders-id-metadata"},{"title":"Create metadata instance on folder","openapi":"box-openapi.json POST /folders/{folder_id}/metadata/{scope}/{template_key}","href":"/reference/post-folders-id-metadata-id-id"},{"title":"Update metadata instance on folder","openapi":"box-openapi.json PUT /folders/{folder_id}/metadata/{scope}/{template_key}","href":"/reference/put-folders-id-metadata-id-id"},{"title":"Remove metadata instance from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/metadata/{scope}/{template_key}","href":"/reference/delete-folders-id-metadata-id-id"}]},{"group":"Metadata taxonomies","root":{"title":"Metadata taxonomies resources","href":"/reference/metadata-taxonomies-resources"},"pages":[{"title":"Get metadata taxonomies for namespace","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}","href":"/reference/get-metadata-taxonomies-id"},{"title":"Get metadata taxonomy by taxonomy key","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}","href":"/reference/get-metadata-taxonomies-id-id"},{"title":"Get metadata taxonomy node by ID","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","href":"/reference/get-metadata-taxonomies-id-id-nodes-id"},{"title":"List metadata taxonomy nodes","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","href":"/reference/get-metadata-taxonomies-id-id-nodes"},{"title":"List metadata template's options for taxonomy field","openapi":"box-openapi.json GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options","href":"/reference/get-metadata-templates-id-id-fields-id-options"},{"title":"Add metadata taxonomy level","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append","href":"/reference/post-metadata-taxonomies-id-id-levels--append"},{"title":"Create metadata taxonomy","openapi":"box-openapi.json POST /metadata_taxonomies","href":"/reference/post-metadata-taxonomies"},{"title":"Create metadata taxonomy levels","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels","href":"/reference/post-metadata-taxonomies-id-id-levels"},{"title":"Create metadata taxonomy node","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","href":"/reference/post-metadata-taxonomies-id-id-nodes"},{"title":"Delete metadata taxonomy level","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim","href":"/reference/post-metadata-taxonomies-id-id-levels--trim"},{"title":"Update metadata taxonomy","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}","href":"/reference/patch-metadata-taxonomies-id-id"},{"title":"Update metadata taxonomy level","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}","href":"/reference/patch-metadata-taxonomies-id-id-levels-id"},{"title":"Update metadata taxonomy node","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","href":"/reference/patch-metadata-taxonomies-id-id-nodes-id"},{"title":"Remove metadata taxonomy","openapi":"box-openapi.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}","href":"/reference/delete-metadata-taxonomies-id-id"},{"title":"Remove metadata taxonomy node","openapi":"box-openapi.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","href":"/reference/delete-metadata-taxonomies-id-id-nodes-id"}]},{"group":"Metadata templates","root":{"title":"Metadata templates resources","href":"/reference/metadata-templates-resources"},"pages":[{"title":"Find metadata template by instance ID","openapi":"box-openapi.json GET /metadata_templates","href":"/reference/get-metadata-templates"},{"title":"Get metadata template by ID","openapi":"box-openapi.json GET /metadata_templates/{template_id}","href":"/reference/get-metadata-templates-id"},{"title":"Get metadata template by name","openapi":"box-openapi.json GET /metadata_templates/{scope}/{template_key}/schema","href":"/reference/get-metadata-templates-id-id-schema"},{"title":"List all global metadata templates","openapi":"box-openapi.json GET /metadata_templates/global","href":"/reference/get-metadata-templates-global"},{"title":"List all metadata templates for enterprise","openapi":"box-openapi.json GET /metadata_templates/enterprise","href":"/reference/get-metadata-templates-enterprise"},{"title":"Create metadata template","openapi":"box-openapi.json POST /metadata_templates/schema","href":"/reference/post-metadata-templates-schema"},{"title":"Update metadata template","openapi":"box-openapi.json PUT /metadata_templates/{scope}/{template_key}/schema","href":"/reference/put-metadata-templates-id-id-schema"},{"title":"Remove metadata template","openapi":"box-openapi.json DELETE /metadata_templates/{scope}/{template_key}/schema","href":"/reference/delete-metadata-templates-id-id-schema"}]},{"group":"Recent items","root":{"title":"Recent items resources","href":"/reference/recent-items-resources"},"pages":[{"title":"List recently accessed items","openapi":"box-openapi.json GET /recent_items","href":"/reference/get-recent-items"}]},{"group":"Retention policies","root":{"title":"Retention policies resources","href":"/reference/retention-policies-resources"},"pages":[{"title":"Get retention policy","openapi":"box-openapi.json GET /retention_policies/{retention_policy_id}","href":"/reference/get-retention-policies-id"},{"title":"List retention policies","openapi":"box-openapi.json GET /retention_policies","href":"/reference/get-retention-policies"},{"title":"Create retention policy","openapi":"box-openapi.json POST /retention_policies","href":"/reference/post-retention-policies"},{"title":"Update retention policy","openapi":"box-openapi.json PUT /retention_policies/{retention_policy_id}","href":"/reference/put-retention-policies-id"},{"title":"Delete retention policy","openapi":"box-openapi.json DELETE /retention_policies/{retention_policy_id}","href":"/reference/delete-retention-policies-id"}]},{"group":"Retention policy assignments","root":{"title":"Retention policy assignments resources","href":"/reference/retention-policy-assignments-resources"},"pages":[{"title":"Get file versions under retention","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention","href":"/reference/get-retention-policy-assignments-id-file-versions-under-retention"},{"title":"Get files under retention","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention","href":"/reference/get-retention-policy-assignments-id-files-under-retention"},{"title":"Get retention policy assignment","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}","href":"/reference/get-retention-policy-assignments-id"},{"title":"List retention policy assignments","openapi":"box-openapi.json GET /retention_policies/{retention_policy_id}/assignments","href":"/reference/get-retention-policies-id-assignments"},{"title":"Assign retention policy","openapi":"box-openapi.json POST /retention_policy_assignments","href":"/reference/post-retention-policy-assignments"},{"title":"Remove retention policy assignment","openapi":"box-openapi.json DELETE /retention_policy_assignments/{retention_policy_assignment_id}","href":"/reference/delete-retention-policy-assignments-id"}]},{"group":"Search","root":{"title":"Search resources","href":"/reference/search-resources"},"pages":[{"title":"Search for content","openapi":"box-openapi.json GET /search","href":"/reference/get-search"},{"title":"Query files/folders by metadata","openapi":"box-openapi.json POST /metadata_queries/execute_read","href":"/reference/post-metadata-queries-execute-read"}]},{"group":"Session termination","root":{"title":"Session termination resources","href":"/reference/session-termination-resources"},"pages":[{"title":"Create jobs to terminate user group session","openapi":"box-openapi.json POST /groups/terminate_sessions","href":"/reference/post-groups-terminate-sessions"},{"title":"Create jobs to terminate users session","openapi":"box-openapi.json POST /users/terminate_sessions","href":"/reference/post-users-terminate-sessions"}]},{"group":"Shared links (App Items)","pages":[{"title":"Find app item for shared link","openapi":"box-openapi.json GET /shared_items#app_items","href":"/reference/get-shared-items--app-items"}]},{"group":"Shared links (Files)","pages":[{"title":"Find file for shared link","openapi":"box-openapi.json GET /shared_items","href":"/reference/get-shared-items"},{"title":"Get shared link for file","openapi":"box-openapi.json GET /files/{file_id}#get_shared_link","href":"/reference/get-files-id--get-shared-link"},{"title":"Add shared link to file","openapi":"box-openapi.json PUT /files/{file_id}#add_shared_link","href":"/reference/put-files-id--add-shared-link"},{"title":"Remove shared link from file","openapi":"box-openapi.json PUT /files/{file_id}#remove_shared_link","href":"/reference/put-files-id--remove-shared-link"},{"title":"Update shared link on file","openapi":"box-openapi.json PUT /files/{file_id}#update_shared_link","href":"/reference/put-files-id--update-shared-link"}]},{"group":"Shared links (Folders)","pages":[{"title":"Find folder for shared link","openapi":"box-openapi.json GET /shared_items#folders","href":"/reference/get-shared-items--folders"},{"title":"Get shared link for folder","openapi":"box-openapi.json GET /folders/{folder_id}#get_shared_link","href":"/reference/get-folders-id--get-shared-link"},{"title":"Add shared link to folder","openapi":"box-openapi.json PUT /folders/{folder_id}#add_shared_link","href":"/reference/put-folders-id--add-shared-link"},{"title":"Remove shared link from folder","openapi":"box-openapi.json PUT /folders/{folder_id}#remove_shared_link","href":"/reference/put-folders-id--remove-shared-link"},{"title":"Update shared link on folder","openapi":"box-openapi.json PUT /folders/{folder_id}#update_shared_link","href":"/reference/put-folders-id--update-shared-link"}]},{"group":"Shared links (Web Links)","pages":[{"title":"Find web link for shared link","openapi":"box-openapi.json GET /shared_items#web_links","href":"/reference/get-shared-items--web-links"},{"title":"Get shared link for web link","openapi":"box-openapi.json GET /web_links/{web_link_id}#get_shared_link","href":"/reference/get-web-links-id--get-shared-link"},{"title":"Add shared link to web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#add_shared_link","href":"/reference/put-web-links-id--add-shared-link"},{"title":"Remove shared link from web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#remove_shared_link","href":"/reference/put-web-links-id--remove-shared-link"},{"title":"Update shared link on web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#update_shared_link","href":"/reference/put-web-links-id--update-shared-link"}]},{"group":"Shield information barrier reports","root":{"title":"Shield information barrier reports resources","href":"/reference/shield-information-barrier-reports-resources"},"pages":[{"title":"Get shield information barrier report by ID","openapi":"box-openapi.json GET /shield_information_barrier_reports/{shield_information_barrier_report_id}","href":"/reference/get-shield-information-barrier-reports-id"},{"title":"List shield information barrier reports","openapi":"box-openapi.json GET /shield_information_barrier_reports","href":"/reference/get-shield-information-barrier-reports"},{"title":"Create shield information barrier report","openapi":"box-openapi.json POST /shield_information_barrier_reports","href":"/reference/post-shield-information-barrier-reports"}]},{"group":"Shield information barrier segment members","root":{"title":"Shield information barrier segment members resources","href":"/reference/shield-information-barrier-segment-members-resources"},"pages":[{"title":"Get shield information barrier segment member by ID","openapi":"box-openapi.json GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","href":"/reference/get-shield-information-barrier-segment-members-id"},{"title":"List shield information barrier segment members","openapi":"box-openapi.json GET /shield_information_barrier_segment_members","href":"/reference/get-shield-information-barrier-segment-members"},{"title":"Create shield information barrier segment member","openapi":"box-openapi.json POST /shield_information_barrier_segment_members","href":"/reference/post-shield-information-barrier-segment-members"},{"title":"Delete shield information barrier segment member by ID","openapi":"box-openapi.json DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","href":"/reference/delete-shield-information-barrier-segment-members-id"}]},{"group":"Shield information barrier segment restrictions","root":{"title":"Shield information barrier segment restrictions resources","href":"/reference/shield-information-barrier-segment-restrictions-resources"},"pages":[{"title":"Get shield information barrier segment restriction by ID","openapi":"box-openapi.json GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","href":"/reference/get-shield-information-barrier-segment-restrictions-id"},{"title":"List shield information barrier segment restrictions","openapi":"box-openapi.json GET /shield_information_barrier_segment_restrictions","href":"/reference/get-shield-information-barrier-segment-restrictions"},{"title":"Create shield information barrier segment restriction","openapi":"box-openapi.json POST /shield_information_barrier_segment_restrictions","href":"/reference/post-shield-information-barrier-segment-restrictions"},{"title":"Delete shield information barrier segment restriction by ID","openapi":"box-openapi.json DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","href":"/reference/delete-shield-information-barrier-segment-restrictions-id"}]},{"group":"Shield information barrier segments","root":{"title":"Shield information barrier segments resources","href":"/reference/shield-information-barrier-segments-resources"},"pages":[{"title":"Get shield information barrier segment with specified ID","openapi":"box-openapi.json GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}","href":"/reference/get-shield-information-barrier-segments-id"},{"title":"List shield information barrier segments","openapi":"box-openapi.json GET /shield_information_barrier_segments","href":"/reference/get-shield-information-barrier-segments"},{"title":"Create shield information barrier segment","openapi":"box-openapi.json POST /shield_information_barrier_segments","href":"/reference/post-shield-information-barrier-segments"},{"title":"Update shield information barrier segment with specified ID","openapi":"box-openapi.json PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}","href":"/reference/put-shield-information-barrier-segments-id"},{"title":"Delete shield information barrier segment","openapi":"box-openapi.json DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}","href":"/reference/delete-shield-information-barrier-segments-id"}]},{"group":"Shield information barriers","root":{"title":"Shield information barriers resources","href":"/reference/shield-information-barriers-resources"},"pages":[{"title":"Get shield information barrier with specified ID","openapi":"box-openapi.json GET /shield_information_barriers/{shield_information_barrier_id}","href":"/reference/get-shield-information-barriers-id"},{"title":"List shield information barriers","openapi":"box-openapi.json GET /shield_information_barriers","href":"/reference/get-shield-information-barriers"},{"title":"Add changed status of shield information barrier with specified ID","openapi":"box-openapi.json POST /shield_information_barriers/change_status","href":"/reference/post-shield-information-barriers-change-status"},{"title":"Create shield information barrier","openapi":"box-openapi.json POST /shield_information_barriers","href":"/reference/post-shield-information-barriers"}]},{"group":"Skills","root":{"title":"Skills resources","href":"/reference/skills-resources"},"pages":[{"title":"List Box Skill cards on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/global/boxSkillsCards","href":"/reference/get-files-id-metadata-global-boxSkillsCards"},{"title":"Create Box Skill cards on file","openapi":"box-openapi.json POST /files/{file_id}/metadata/global/boxSkillsCards","href":"/reference/post-files-id-metadata-global-boxSkillsCards"},{"title":"Update all Box Skill cards on file","openapi":"box-openapi.json PUT /skill_invocations/{skill_id}","href":"/reference/put-skill-invocations-id"},{"title":"Update Box Skill cards on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/global/boxSkillsCards","href":"/reference/put-files-id-metadata-global-boxSkillsCards"},{"title":"Remove Box Skill cards from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/global/boxSkillsCards","href":"/reference/delete-files-id-metadata-global-boxSkillsCards"}]},{"group":"Standard and Zones Storage Policies","root":{"title":"Standard and Zones Storage Policies resources","href":"/reference/storage-policies-resources"},"pages":[{"title":"Get storage policy","openapi":"box-openapi.json GET /storage_policies/{storage_policy_id}","href":"/reference/get-storage-policies-id"},{"title":"List storage policies","openapi":"box-openapi.json GET /storage_policies","href":"/reference/get-storage-policies"}]},{"group":"Standard and Zones Storage Policy Assignments","root":{"title":"Standard and Zones Storage Policy Assignments resources","href":"/reference/storage-policy-assignments-resources"},"pages":[{"title":"Get storage policy assignment","openapi":"box-openapi.json GET /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/get-storage-policy-assignments-id"},{"title":"List storage policy assignments","openapi":"box-openapi.json GET /storage_policy_assignments","href":"/reference/get-storage-policy-assignments"},{"title":"Assign storage policy","openapi":"box-openapi.json POST /storage_policy_assignments","href":"/reference/post-storage-policy-assignments"},{"title":"Update storage policy assignment","openapi":"box-openapi.json PUT /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/put-storage-policy-assignments-id"},{"title":"Unassign storage policy","openapi":"box-openapi.json DELETE /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/delete-storage-policy-assignments-id"}]},{"group":"Task assignments","root":{"title":"Task assignments resources","href":"/reference/task-assignments-resources"},"pages":[{"title":"Get task assignment","openapi":"box-openapi.json GET /task_assignments/{task_assignment_id}","href":"/reference/get-task-assignments-id"},{"title":"List task assignments","openapi":"box-openapi.json GET /tasks/{task_id}/assignments","href":"/reference/get-tasks-id-assignments"},{"title":"Assign task","openapi":"box-openapi.json POST /task_assignments","href":"/reference/post-task-assignments"},{"title":"Update task assignment","openapi":"box-openapi.json PUT /task_assignments/{task_assignment_id}","href":"/reference/put-task-assignments-id"},{"title":"Unassign task","openapi":"box-openapi.json DELETE /task_assignments/{task_assignment_id}","href":"/reference/delete-task-assignments-id"}]},{"group":"Tasks","root":{"title":"Tasks resources","href":"/reference/tasks-resources"},"pages":[{"title":"Get task","openapi":"box-openapi.json GET /tasks/{task_id}","href":"/reference/get-tasks-id"},{"title":"List tasks on file","openapi":"box-openapi.json GET /files/{file_id}/tasks","href":"/reference/get-files-id-tasks"},{"title":"Create task","openapi":"box-openapi.json POST /tasks","href":"/reference/post-tasks"},{"title":"Update task","openapi":"box-openapi.json PUT /tasks/{task_id}","href":"/reference/put-tasks-id"},{"title":"Remove task","openapi":"box-openapi.json DELETE /tasks/{task_id}","href":"/reference/delete-tasks-id"}]},{"group":"Terms of service","root":{"title":"Terms of service resources","href":"/reference/terms-of-services-resources"},"pages":[{"title":"Get terms of service","openapi":"box-openapi.json GET /terms_of_services/{terms_of_service_id}","href":"/reference/get-terms-of-services-id"},{"title":"List terms of services","openapi":"box-openapi.json GET /terms_of_services","href":"/reference/get-terms-of-services"},{"title":"Create terms of service","openapi":"box-openapi.json POST /terms_of_services","href":"/reference/post-terms-of-services"},{"title":"Update terms of service","openapi":"box-openapi.json PUT /terms_of_services/{terms_of_service_id}","href":"/reference/put-terms-of-services-id"}]},{"group":"Terms of service user statuses","root":{"title":"Terms of service user statuses resources","href":"/reference/terms-of-service-user-statuses-resources"},"pages":[{"title":"List terms of service user statuses","openapi":"box-openapi.json GET /terms_of_service_user_statuses","href":"/reference/get-terms-of-service-user-statuses"},{"title":"Create terms of service status for new user","openapi":"box-openapi.json POST /terms_of_service_user_statuses","href":"/reference/post-terms-of-service-user-statuses"},{"title":"Update terms of service status for existing user","openapi":"box-openapi.json PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}","href":"/reference/put-terms-of-service-user-statuses-id"}]},{"group":"Transfer folders","pages":[{"title":"Transfer owned folders","openapi":"box-openapi.json PUT /users/{user_id}/folders/0","href":"/reference/put-users-id-folders-0"}]},{"group":"Trashed files","root":{"title":"Trashed files resources","href":"/reference/trashed-files-resources"},"pages":[{"title":"Get trashed file","openapi":"box-openapi.json GET /files/{file_id}/trash","href":"/reference/get-files-id-trash"},{"title":"Restore file","openapi":"box-openapi.json POST /files/{file_id}","href":"/reference/post-files-id"},{"title":"Permanently remove file","openapi":"box-openapi.json DELETE /files/{file_id}/trash","href":"/reference/delete-files-id-trash"}]},{"group":"Trashed folders","root":{"title":"Trashed folders resources","href":"/reference/trashed-folders-resources"},"pages":[{"title":"Get trashed folder","openapi":"box-openapi.json GET /folders/{folder_id}/trash","href":"/reference/get-folders-id-trash"},{"title":"Restore folder","openapi":"box-openapi.json POST /folders/{folder_id}","href":"/reference/post-folders-id"},{"title":"Permanently remove folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/trash","href":"/reference/delete-folders-id-trash"}]},{"group":"Trashed items","pages":[{"title":"List trashed items","openapi":"box-openapi.json GET /folders/trash/items","href":"/reference/get-folders-trash-items"}]},{"group":"Trashed web links","root":{"title":"Trashed web links resources","href":"/reference/trashed-web-links-resources"},"pages":[{"title":"Get trashed web link","openapi":"box-openapi.json GET /web_links/{web_link_id}/trash","href":"/reference/get-web-links-id-trash"},{"title":"Restore web link","openapi":"box-openapi.json POST /web_links/{web_link_id}","href":"/reference/post-web-links-id"},{"title":"Permanently remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}/trash","href":"/reference/delete-web-links-id-trash"}]},{"group":"Uploads","root":{"title":"Uploads resources","href":"/reference/uploads-resources"},"pages":[{"title":"Upload file","openapi":"box-openapi.json POST /files/content","href":"/reference/post-files-content"},{"title":"Upload file version","openapi":"box-openapi.json POST /files/{file_id}/content","href":"/reference/post-files-id-content"},{"title":"Preflight check before upload","openapi":"/box-openapi.json OPTIONS /files/content","href":"/reference/options-files-content"}]},{"group":"Uploads (Chunked)","root":{"title":"Uploads (Chunked) resources","href":"/reference/chunked-uploads-resources"},"pages":[{"title":"Get upload session","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}","href":"/reference/get-files-upload-sessions-id"},{"title":"List parts","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}/parts","href":"/reference/get-files-upload-sessions-id-parts"},{"title":"Commit upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/commit","href":"/reference/post-files-upload-sessions-id-commit"},{"title":"Create upload session","openapi":"box-openapi.json POST /files/upload_sessions","href":"/reference/post-files-upload-sessions"},{"title":"Create upload session for existing file","openapi":"box-openapi.json POST /files/{file_id}/upload_sessions","href":"/reference/post-files-id-upload-sessions"},{"title":"Plan upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/plan","href":"/reference/post-files-upload-sessions-id-plan"},{"title":"Upload part of file","openapi":"box-openapi.json PUT /files/upload_sessions/{upload_session_id}","href":"/reference/put-files-upload-sessions-id"},{"title":"Remove upload session","openapi":"box-openapi.json DELETE /files/upload_sessions/{upload_session_id}","href":"/reference/delete-files-upload-sessions-id"}]},{"group":"User avatars","root":{"title":"User avatars resources","href":"/reference/avatars-resources"},"pages":[{"title":"Get user avatar","openapi":"box-openapi.json GET /users/{user_id}/avatar","href":"/reference/get-users-id-avatar"},{"title":"Add or update user avatar","openapi":"box-openapi.json POST /users/{user_id}/avatar","href":"/reference/post-users-id-avatar"},{"title":"Delete user avatar","openapi":"box-openapi.json DELETE /users/{user_id}/avatar","href":"/reference/delete-users-id-avatar"}]},{"group":"Users","root":{"title":"Users resources","href":"/reference/users-resources"},"pages":[{"title":"Get current user","openapi":"box-openapi.json GET /users/me","href":"/reference/get-users-me"},{"title":"Get user","openapi":"box-openapi.json GET /users/{user_id}","href":"/reference/get-users-id"},{"title":"List enterprise users","openapi":"box-openapi.json GET /users","href":"/reference/get-users"},{"title":"Create user","openapi":"box-openapi.json POST /users","href":"/reference/post-users"},{"title":"Update user","openapi":"box-openapi.json PUT /users/{user_id}","href":"/reference/put-users-id"},{"title":"Delete user","openapi":"box-openapi.json DELETE /users/{user_id}","href":"/reference/delete-users-id"}]},{"group":"Watermarks (Files)","root":{"title":"Watermarks (Files) resources","href":"/reference/file-watermarks-resources"},"pages":[{"title":"Get watermark on file","openapi":"box-openapi.json GET /files/{file_id}/watermark","href":"/reference/get-files-id-watermark"},{"title":"Apply watermark to file","openapi":"box-openapi.json PUT /files/{file_id}/watermark","href":"/reference/put-files-id-watermark"},{"title":"Remove watermark from file","openapi":"box-openapi.json DELETE /files/{file_id}/watermark","href":"/reference/delete-files-id-watermark"}]},{"group":"Watermarks (Folders)","pages":[{"title":"Get watermark for folder","openapi":"box-openapi.json GET /folders/{folder_id}/watermark","href":"/reference/get-folders-id-watermark"},{"title":"Apply watermark to folder","openapi":"box-openapi.json PUT /folders/{folder_id}/watermark","href":"/reference/put-folders-id-watermark"},{"title":"Remove watermark from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/watermark","href":"/reference/delete-folders-id-watermark"}]},{"group":"Web links","root":{"title":"Web links resources","href":"/reference/web-links-resources"},"pages":[{"title":"Get web link","openapi":"box-openapi.json GET /web_links/{web_link_id}","href":"/reference/get-web-links-id"},{"title":"Create web link","openapi":"box-openapi.json POST /web_links","href":"/reference/post-web-links"},{"title":"Update web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}","href":"/reference/put-web-links-id"},{"title":"Remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}","href":"/reference/delete-web-links-id"}]},{"group":"Webhooks","root":{"title":"Webhooks resources","href":"/reference/webhooks-resources"},"pages":[{"title":"Get webhook","openapi":"box-openapi.json GET /webhooks/{webhook_id}","href":"/reference/get-webhooks-id"},{"title":"List all webhooks","openapi":"box-openapi.json GET /webhooks","href":"/reference/get-webhooks"},{"title":"Create webhook","openapi":"box-openapi.json POST /webhooks","href":"/reference/post-webhooks"},{"title":"Update webhook","openapi":"box-openapi.json PUT /webhooks/{webhook_id}","href":"/reference/put-webhooks-id"},{"title":"Remove webhook","openapi":"box-openapi.json DELETE /webhooks/{webhook_id}","href":"/reference/delete-webhooks-id"}]},{"group":"Workflows","root":{"title":"Workflows resources","href":"/reference/workflows-resources"},"pages":[{"title":"List workflows","openapi":"box-openapi.json GET /workflows","description":"Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.","href":"/reference/get-workflows"},{"title":"Starts workflow based on request body","openapi":"box-openapi.json POST /workflows/{workflow_id}/start","href":"/reference/post-workflows-id-start"}]},{"group":"Zip Downloads","root":{"title":"Zip Downloads resources","description":null,"href":"/reference/zip-downloads-resources"},"pages":[{"title":"Download zip archive","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/content","href":"/reference/get-zip-downloads-id-content"},{"title":"Get zip download status","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/status","href":"/reference/get-zip-downloads-id-status"},{"title":"Create zip download","openapi":"box-openapi.json POST /zip_downloads","href":"/reference/post-zip-downloads"}]}]},{"group":"v2025.0","pages":[{"group":"Archives","root":{"title":"Archives resources","href":"/reference/v2025.0/archives-resources"},"pages":[{"title":"List archives","openapi":"box-openapi-v2025.0.json GET /archives","href":"/reference/v2025.0/get-archives"},{"title":"Create archive","openapi":"box-openapi-v2025.0.json POST /archives","href":"/reference/v2025.0/post-archives"},{"title":"Update archive","openapi":"box-openapi-v2025.0.json PUT /archives/{archive_id}","href":"/reference/v2025.0/put-archives-id"},{"title":"Delete archive","openapi":"box-openapi-v2025.0.json DELETE /archives/{archive_id}","href":"/reference/v2025.0/delete-archives-id"}]},{"group":"Box Doc Gen","root":{"title":"Box Doc Gen resources","href":"/reference/v2025.0/docgen-resources"},"pages":[{"title":"Get Box Doc Gen job by ID","openapi":"box-openapi-v2025.0.json GET /docgen_jobs/{job_id}","href":"/reference/v2025.0/get-docgen-jobs-id"},{"title":"Get Box Doc Gen jobs by batch ID","openapi":"box-openapi-v2025.0.json GET /docgen_batch_jobs/{batch_id}","href":"/reference/v2025.0/get-docgen-batch-jobs-id"},{"title":"List all Box Doc Gen jobs","openapi":"box-openapi-v2025.0.json GET /docgen_jobs","href":"/reference/v2025.0/get-docgen-jobs"},{"title":"Generate document using Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_batches","href":"/reference/v2025.0/post-docgen-batches"}]},{"group":"Box Doc Gen templates","root":{"title":"Box Doc Gen templates resources","href":"/reference/v2025.0/docgen-template-resources"},"pages":[{"title":"Get Box Doc Gen template by ID","openapi":"box-openapi-v2025.0.json GET /docgen_templates/{template_id}","href":"/reference/v2025.0/get-docgen-templates-id"},{"title":"Get list of all Box Doc Gen jobs for template","openapi":"box-openapi-v2025.0.json GET /docgen_template_jobs/{template_id}","href":"/reference/v2025.0/get-docgen-template-jobs-id"},{"title":"List all Box Doc Gen template tags in template","openapi":"box-openapi-v2025.0.json GET /docgen_templates/{template_id}/tags","href":"/reference/v2025.0/get-docgen-templates-id-tags"},{"title":"List Box Doc Gen templates","openapi":"box-openapi-v2025.0.json GET /docgen_templates","href":"/reference/v2025.0/get-docgen-templates"},{"title":"Create Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_templates","href":"/reference/v2025.0/post-docgen-templates"},{"title":"Delete Box Doc Gen template","openapi":"box-openapi-v2025.0.json DELETE /docgen_templates/{template_id}","href":"/reference/v2025.0/delete-docgen-templates-id"}]},{"group":"Box Hub Collaborations","root":{"title":"Box Hub Collaborations resources","href":"/reference/v2025.0/hub-collaborations-resources"},"pages":[{"title":"Get Box Hub collaboration by collaboration ID","openapi":"box-openapi-v2025.0.json GET /hub_collaborations/{hub_collaboration_id}","href":"/reference/v2025.0/get-hub-collaborations-id"},{"title":"Get Box Hub collaborations","openapi":"box-openapi-v2025.0.json GET /hub_collaborations","href":"/reference/v2025.0/get-hub-collaborations"},{"title":"Create Box Hub collaboration","openapi":"box-openapi-v2025.0.json POST /hub_collaborations","href":"/reference/v2025.0/post-hub-collaborations"},{"title":"Update Box Hub collaboration","openapi":"box-openapi-v2025.0.json PUT /hub_collaborations/{hub_collaboration_id}","href":"/reference/v2025.0/put-hub-collaborations-id"},{"title":"Remove Box Hub collaboration","openapi":"box-openapi-v2025.0.json DELETE /hub_collaborations/{hub_collaboration_id}","href":"/reference/v2025.0/delete-hub-collaborations-id"}]},{"group":"Box Hub Document","root":{"title":"Box Hub Document resources","href":"/reference/v2025.0/hub-document-resources"},"pages":[{"title":"List Hub Document blocks for page","openapi":"box-openapi-v2025.0.json GET /hub_document_blocks","href":"/reference/v2025.0/get-hub-document-blocks"},{"title":"List Hub Document Pages","openapi":"box-openapi-v2025.0.json GET /hub_document_pages","href":"/reference/v2025.0/get-hub-document-pages"}]},{"group":"Box Hub Items","root":{"title":"Box Hub Items resources","href":"/reference/v2025.0/hub-items-resources"},"pages":[{"title":"Get Box Hub items","openapi":"box-openapi-v2025.0.json GET /hub_items","href":"/reference/v2025.0/get-hub-items"},{"title":"Manage Box Hub items","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/manage_items","href":"/reference/v2025.0/post-hubs-id-manage-items"}]},{"group":"Box Hubs","root":{"title":"Box Hubs resources","href":"/reference/v2025.0/hubs-resources"},"pages":[{"title":"Get Box Hub information by ID","openapi":"box-openapi-v2025.0.json GET /hubs/{hub_id}","href":"/reference/v2025.0/get-hubs-id"},{"title":"List all Box Hubs","openapi":"box-openapi-v2025.0.json GET /hubs","href":"/reference/v2025.0/get-hubs"},{"title":"List all Box Hubs for requesting enterprise","openapi":"box-openapi-v2025.0.json GET /enterprise_hubs","href":"/reference/v2025.0/get-enterprise-hubs"},{"title":"Copy Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/copy","href":"/reference/v2025.0/post-hubs-id-copy"},{"title":"Create Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs","href":"/reference/v2025.0/post-hubs"},{"title":"Update Box Hub information by ID","openapi":"box-openapi-v2025.0.json PUT /hubs/{hub_id}","href":"/reference/v2025.0/put-hubs-id"},{"title":"Delete Box Hub","openapi":"box-openapi-v2025.0.json DELETE /hubs/{hub_id}","href":"/reference/v2025.0/delete-hubs-id"}]},{"group":"Enterprise Configurations","root":{"title":"Enterprise Configurations resources","href":"/reference/v2025.0/enterprise-configurations-resources"},"pages":[{"title":"Get enterprise configuration","openapi":"box-openapi-v2025.0.json GET /enterprise_configurations/{enterprise_id}","href":"/reference/v2025.0/get-enterprise-configurations-id"}]},{"group":"External Users","root":{"title":"External Users resources","href":"/reference/v2025.0/external-users-resources"},"pages":[{"title":"Submit job to delete external users","openapi":"box-openapi-v2025.0.json POST /external_users/submit_delete_job","href":"/reference/v2025.0/post-external-users-submit-delete-job"}]},{"group":"Shield lists","root":{"title":"Shield lists resources","href":"/reference/v2025.0/shield-lists-resources"},"pages":[{"title":"Get all shield lists in enterprise","openapi":"box-openapi-v2025.0.json GET /shield_lists","href":"/reference/v2025.0/get-shield-lists"},{"title":"Get single shield list by shield list id","openapi":"box-openapi-v2025.0.json GET /shield_lists/{shield_list_id}","href":"/reference/v2025.0/get-shield-lists-id"},{"title":"Create shield list","openapi":"box-openapi-v2025.0.json POST /shield_lists","href":"/reference/v2025.0/post-shield-lists"},{"title":"Update shield list","openapi":"box-openapi-v2025.0.json PUT /shield_lists/{shield_list_id}","href":"/reference/v2025.0/put-shield-lists-id"},{"title":"Delete single shield list by shield list id","openapi":"box-openapi-v2025.0.json DELETE /shield_lists/{shield_list_id}","href":"/reference/v2025.0/delete-shield-lists-id"}]}]},{"group":"v2026.0","pages":[{"group":"Automate Workflows","tag":"Beta","pages":[{"title":"List Automate workflows defined as callable actions","openapi":"box-openapi-v2026.0.json GET /automate_workflows","tag":"Beta","href":"/reference/v2026.0/get-automate-workflows"},{"title":"Start Automate workflow","openapi":"box-openapi-v2026.0.json POST /automate_workflows/{workflow_id}/start","tag":"Beta","href":"/reference/v2026.0/post-automate-workflows-id-start"}]},{"group":"Convert to Box Note","root":{"title":"Convert to Box Note resources","href":"/reference/v2026.0/notes-resources"},"pages":[{"title":"Convert content to Box Note","openapi":"box-openapi-v2026.0.json POST /notes/convert","href":"/reference/v2026.0/post-notes-convert"}]},{"group":"Document Split","root":{"title":"Document Split resources","href":"/reference/v2026.0/document-split-resources"},"pages":[{"title":"Get Document Split job by ID","openapi":"box-openapi-v2026.0.json GET /document_splits/{document_split_id}","href":"/reference/v2026.0/get-document-splits-id"},{"title":"List Document Split jobs","openapi":"box-openapi-v2026.0.json GET /document_splits","href":"/reference/v2026.0/get-document-splits"},{"title":"Create Document Split job","openapi":"box-openapi-v2026.0.json POST /document_splits","href":"/reference/v2026.0/post-document-splits"}]},{"group":"Query","root":{"title":"Query resources","href":"/reference/v2026.0/query-resources"},"pages":[{"title":"Box Query","openapi":"box-openapi-v2026.0.json POST /query","href":"/reference/v2026.0/post-query"},{"title":"Create insights for Box items","openapi":"box-openapi-v2026.0.json POST /query_insights","href":"/reference/v2026.0/post-query-insights"}]},{"group":"Shuttle","root":{"title":"Shuttle resources","href":"/reference/v2026.0/shuttle-resources"},"pages":[{"title":"Get shuttle job by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/get-shuttle-jobs-id"},{"title":"Get shuttle job schedule","openapi":"box-openapi-v2026.0.json GET /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/get-shuttle-job-schedules-id"},{"title":"Get shuttle path mapping by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/get-shuttle-path-mappings-id"},{"title":"Get shuttle report by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_reports/{shuttle_report_id}","href":"/reference/v2026.0/get-shuttle-reports-id"},{"title":"Get shuttle run by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_runs/{shuttle_run_id}","href":"/reference/v2026.0/get-shuttle-runs-id"},{"title":"Get shuttle subject mapping by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/get-shuttle-subject-mappings-id"},{"title":"Get shuttle system by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/get-shuttle-systems-id"},{"title":"List shuttle discovered subjects","openapi":"box-openapi-v2026.0.json GET /shuttle_discovered_subjects","href":"/reference/v2026.0/get-shuttle-discovered-subjects"},{"title":"List shuttle job schedules","openapi":"box-openapi-v2026.0.json GET /shuttle_job_schedules","href":"/reference/v2026.0/get-shuttle-job-schedules"},{"title":"List shuttle jobs","openapi":"box-openapi-v2026.0.json GET /shuttle_jobs","href":"/reference/v2026.0/get-shuttle-jobs"},{"title":"List shuttle mapping errors","openapi":"box-openapi-v2026.0.json GET /shuttle_mapping_errors","href":"/reference/v2026.0/get-shuttle-mapping-errors"},{"title":"List shuttle path entries","openapi":"box-openapi-v2026.0.json GET /shuttle_path_entries","href":"/reference/v2026.0/get-shuttle-path-entries"},{"title":"List shuttle path mappings","openapi":"box-openapi-v2026.0.json GET /shuttle_path_mappings","href":"/reference/v2026.0/get-shuttle-path-mappings"},{"title":"List shuttle reports","openapi":"box-openapi-v2026.0.json GET /shuttle_reports","href":"/reference/v2026.0/get-shuttle-reports"},{"title":"List shuttle runs","openapi":"box-openapi-v2026.0.json GET /shuttle_runs","href":"/reference/v2026.0/get-shuttle-runs"},{"title":"List shuttle subject mappings","openapi":"box-openapi-v2026.0.json GET /shuttle_subject_mappings","href":"/reference/v2026.0/get-shuttle-subject-mappings"},{"title":"List shuttle systems","openapi":"box-openapi-v2026.0.json GET /shuttle_systems","href":"/reference/v2026.0/get-shuttle-systems"},{"title":"Create shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs","href":"/reference/v2026.0/post-shuttle-jobs"},{"title":"Create shuttle job schedule","openapi":"box-openapi-v2026.0.json POST /shuttle_job_schedules","href":"/reference/v2026.0/post-shuttle-job-schedules"},{"title":"Create shuttle path mapping","openapi":"box-openapi-v2026.0.json POST /shuttle_path_mappings","href":"/reference/v2026.0/post-shuttle-path-mappings"},{"title":"Create shuttle path mapping import","openapi":"box-openapi-v2026.0.json POST /shuttle_path_mapping_imports","href":"/reference/v2026.0/post-shuttle-path-mapping-imports"},{"title":"Create shuttle report","openapi":"box-openapi-v2026.0.json POST /shuttle_reports","href":"/reference/v2026.0/post-shuttle-reports"},{"title":"Create shuttle subject mapping","openapi":"box-openapi-v2026.0.json POST /shuttle_subject_mappings","href":"/reference/v2026.0/post-shuttle-subject-mappings"},{"title":"Create shuttle subject mapping import","openapi":"box-openapi-v2026.0.json POST /shuttle_subject_mapping_imports","href":"/reference/v2026.0/post-shuttle-subject-mapping-imports"},{"title":"Create shuttle system","openapi":"box-openapi-v2026.0.json POST /shuttle_systems","href":"/reference/v2026.0/post-shuttle-systems"},{"title":"Issue registration token for Windows system","openapi":"box-openapi-v2026.0.json POST /shuttle_systems/{shuttle_system_id}/issue_registration_token","href":"/reference/v2026.0/post-shuttle-systems-id-issue-registration-token"},{"title":"Prepare migration","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/prepare_migration","href":"/reference/v2026.0/post-shuttle-jobs-id-prepare-migration"},{"title":"Start shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/start","href":"/reference/v2026.0/post-shuttle-jobs-id-start"},{"title":"Stop shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/stop","href":"/reference/v2026.0/post-shuttle-jobs-id-stop"},{"title":"Update shuttle job","openapi":"box-openapi-v2026.0.json PUT /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/put-shuttle-jobs-id"},{"title":"Update shuttle job schedule","openapi":"box-openapi-v2026.0.json PUT /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/put-shuttle-job-schedules-id"},{"title":"Update shuttle path mapping","openapi":"box-openapi-v2026.0.json PUT /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/put-shuttle-path-mappings-id"},{"title":"Update shuttle subject mapping","openapi":"box-openapi-v2026.0.json PUT /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/put-shuttle-subject-mappings-id"},{"title":"Update shuttle system","openapi":"box-openapi-v2026.0.json PUT /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/put-shuttle-systems-id"},{"title":"Delete shuttle job","openapi":"box-openapi-v2026.0.json DELETE /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/delete-shuttle-jobs-id"},{"title":"Delete shuttle job schedule","openapi":"box-openapi-v2026.0.json DELETE /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/delete-shuttle-job-schedules-id"},{"title":"Delete shuttle path mapping","openapi":"box-openapi-v2026.0.json DELETE /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/delete-shuttle-path-mappings-id"},{"title":"Delete shuttle subject mapping","openapi":"box-openapi-v2026.0.json DELETE /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/delete-shuttle-subject-mappings-id"},{"title":"Delete shuttle system","openapi":"box-openapi-v2026.0.json DELETE /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/delete-shuttle-systems-id"}]}]}]},{"tab":"Tools","pages":[{"title":"Tools","href":"/sdks-and-tools"}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026"}]}],"global":{"anchors":[{"anchor":"Box","icon":"https://mintlify.s3.us-west-1.amazonaws.com/box/images/sidebar/box.svg","href":"https://www.box.com/home"},{"anchor":"Community","icon":"book-open-cover","href":"https://community.box.com/box-platform-5"},{"anchor":"Developer Blog","icon":"newspaper","href":"https://blog.box.com/developer"},{"anchor":"Box SDKs","icon":"code","href":"https://github.com/box/sdks"},{"anchor":"Box Docs","icon":"file-lines","href":"https://docs.box.com"}]}},{"language":"ja","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"リソース","items":[{"label":"ニュースレターの登録解除","href":"https://go.box.com/preferences.html"},{"label":"利用規約","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"個人情報保護方針","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookieに関する通知","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"ログイン","type":"button"}],"primary":{"type":"button","label":"今すぐ無料で開始","href":"https://account.box.com/signup/developer"}},"pages":[{"title":"ja","href":"/ja/reference/post-workflows-id-start"}]}]},"basePath":"","title":"Starts workflow based on request body - Box Dev Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DHaG7hr_.js","dist-DKZWslLH.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-BIWXJmsZ.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","AssistantPageLink-UDqbR6xh.js"]}