{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Scholarly API Documentation","colors":{"primary":"#000000"},"favicon":"https://mintcdn.com/scholarly/GC_tiPK-AVBbjLsH/favicon.png?fit=max\u0026auto=format\u0026n=GC_tiPK-AVBbjLsH\u0026q=85\u0026s=7ce1d4e81d495c62b818efe02e0aef55","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scholarly","hasAudioNarration":false,"actualSubdomain":"scholarly","customDomains":["api-docs.scholarlysoftware.com"],"gitSource":{"type":"github","owner":"scholarly-software","repo":"scholarly","deployBranch":"main","contentDirectory":"api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aee2dc470432e3269a31232","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API reference","count":260},{"language":"default","tag":"Core","count":164},{"language":"default","tag":"Course Evaluations","count":81},{"language":"default","tag":"Webhooks","count":28},{"language":"default","tag":"Workflows","count":19},{"language":"default","tag":"Credit Line Items","count":12},{"language":"default","tag":"Folders","count":12},{"language":"default","tag":"Departments","count":10},{"language":"default","tag":"Profiles","count":10},{"language":"default","tag":"Addresses","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/files/update-a-file","slug":"/api-reference/files/update-a-file","pageMetadata":{"title":"Update a file","description":"Update a file's metadata or move it to a different folder.\n\nThis endpoint can be used to:\n- Update the file name\n- Move the file to a different folder (must be owned by the same user)\n\nTo confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\n","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/files/{id}","href":"/api-reference/files/update-a-file","autogeneratedByOpenApi":true},"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 li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update a file’s metadata or move it to a different folder.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint can be used to:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Update the file name\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Move the file to a different folder (must be owned by the same user)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\"\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a file","description":"Update a file's metadata or move it to a different folder.\n\nThis endpoint can be used to:\n- Update the file name\n- Move the file to a different folder (must be owned by the same user)\n\nTo confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\n","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/files/{id}","href":"/api-reference/files/update-a-file","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update a file","tags":["Files"],"operationId":"updateFile","security":["b31c2308-c4cf-410d-9e05-e9ff1943fbc1"],"parameters":["c4541de9-94d5-4a58-af5f-683f01e7a676"],"responses":{"200":"577b3d7c-b46e-48cc-93cb-eeab73b7c88a","401":"28825bc9-048b-4837-ae57-78c482e05c24","403":"9de25421-e814-44b5-9890-fa6390016e47","404":"2bcadcdf-c842-4c3f-96a8-98a5a41b6e92","422":"79362a01-e2d0-4cb0-9e9e-1bb4f5a62887"},"requestBody":"90dff270-a1da-4cd9-870d-3067cd94e803","description":"Update a file's metadata or move it to a different folder.\n\nThis endpoint can be used to:\n- Update the file name\n- Move the file to a different folder (must be owned by the same user)\n\nTo confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\n","method":"patch","type":"path","servers":["95bee8d2-de0b-4a45-a759-17d5709dfb8a"],"path":"/api/v1/files/{id}","baseUrlOptions":["https://api.scholarlysoftware.com"],"title":"Update a file","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c4541de9-94d5-4a58-af5f-683f01e7a676":{"name":"Authorization","in":"header","required":true,"description":"Bearer token","schema":{"type":"string","isRequired":true,"description":"Bearer token","uniqueKey":"","typeLabel":"string"}},"28595d3c-5144-46bb-b8cd-4048d3066a27":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"file","example":"file","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"annual_report.pdf","uniqueKey":"data.attributes.name","typeLabel":"string"}},"uniqueKey":"data.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"folder":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Set to null to move file to top-level root","required":["type","id"],"properties":{"type":{"type":"string","const":"folder","example":"folder","isRequired":true,"uniqueKey":"data.relationships.folder.data.oneOf.0.type","typeLabel":"string"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.relationships.folder.data.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"data.relationships.folder.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set to null to move file to top-level root","isRequired":true,"uniqueKey":"data.relationships.folder.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.folder.data","typeLabel":"object | null"}},"required":["data"],"uniqueKey":"data.relationships.folder","typeLabel":"object"}},"uniqueKey":"data.relationships","typeLabel":"object"}},"required":["id","type"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"file","attributes":{"name":"annual_report.pdf"},"relationships":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"577b3d7c-b46e-48cc-93cb-eeab73b7c88a":{"description":"file updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"file","example":"file","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"attributes":{"type":"object","properties":{"created_at":{"type":"string","format":"datetime","uniqueKey":"data.attributes.created_at","typeLabel":"string\u003cdatetime>"},"updated_at":{"type":"string","format":"datetime","uniqueKey":"data.attributes.updated_at","typeLabel":"string\u003cdatetime>"},"name":{"type":"string","example":"annual_report.pdf","uniqueKey":"data.attributes.name","typeLabel":"string"},"content_type":{"oneOf":[{"type":"string","example":"application/pdf","uniqueKey":"data.attributes.content_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"application/pdf","uniqueKey":"data.attributes.content_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.content_type","typeLabel":"string | null"},"byte_size":{"oneOf":[{"type":"integer","example":1024000,"uniqueKey":"data.attributes.byte_size.oneOf.0","typeLabel":"integer"},{"type":"null","example":1024000,"uniqueKey":"data.attributes.byte_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.byte_size","typeLabel":"integer | null"},"checksum_md5":{"oneOf":[{"type":"string","uniqueKey":"data.attributes.checksum_md5.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.attributes.checksum_md5.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.checksum_md5","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"data.attributes.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"data.attributes.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.url","typeLabel":"string\u003curi> | null"},"locked":{"oneOf":[{"type":"boolean","uniqueKey":"data.attributes.locked.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.attributes.locked.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.locked","typeLabel":"boolean | null"},"state":{"type":"string","uniqueKey":"data.attributes.state","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"folder":{"oneOf":[{"type":"object","required":["links"],"properties":{"links":{"type":"object","properties":{"related":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.0.links.related.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.0.links.related.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.0.links.related","typeLabel":"string\u003curi> | null"}},"required":["related"],"isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.0.links","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"data.relationships.folder.oneOf.0.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.folder.oneOf.0","typeLabel":"object"},{"type":"object","required":["meta"],"properties":{"meta":{"type":"object","isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.1.meta","typeLabel":"object"},"links":{"type":"object","properties":{"related":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.1.links.related.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.1.links.related.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.folder.oneOf.1.links.related","typeLabel":"string\u003curi> | null"}},"required":["related"],"uniqueKey":"data.relationships.folder.oneOf.1.links","typeLabel":"object"}},"uniqueKey":"data.relationships.folder.oneOf.1","typeLabel":"object"}],"uniqueKey":"data.relationships.folder","typeLabel":"object"},"created_by":{"oneOf":[{"type":"object","required":["links"],"properties":{"links":{"type":"object","properties":{"related":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.0.links.related.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.0.links.related.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.0.links.related","typeLabel":"string\u003curi> | null"}},"required":["related"],"isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.0.links","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"data.relationships.created_by.oneOf.0.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.created_by.oneOf.0","typeLabel":"object"},{"type":"object","required":["meta"],"properties":{"meta":{"type":"object","isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.1.meta","typeLabel":"object"},"links":{"type":"object","properties":{"related":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.1.links.related.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.1.links.related.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.created_by.oneOf.1.links.related","typeLabel":"string\u003curi> | null"}},"required":["related"],"uniqueKey":"data.relationships.created_by.oneOf.1.links","typeLabel":"object"}},"uniqueKey":"data.relationships.created_by.oneOf.1","typeLabel":"object"}],"uniqueKey":"data.relationships.created_by","typeLabel":"object"}},"uniqueKey":"data.relationships","typeLabel":"object"}},"required":["id","type","attributes"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"file","attributes":{"created_at":"\u003cstring>","updated_at":"\u003cstring>","name":"annual_report.pdf","content_type":"application/pdf","byte_size":1024000,"checksum_md5":"\u003cstring>","url":"\u003cstring>","locked":true,"state":"\u003cstring>"},"relationships":{"folder":{"links":{"related":"\u003cstring>"},"meta":{}},"created_by":{"links":{"related":"\u003cstring>"},"meta":{}}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"28825bc9-048b-4837-ae57-78c482e05c24":{"description":"unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9de25421-e814-44b5-9890-fa6390016e47":{"description":"forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2bcadcdf-c842-4c3f-96a8-98a5a41b6e92":{"description":"not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"79362a01-e2d0-4cb0-9e9e-1bb4f5a62887":{"description":"validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","example":"422","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"type":"string","example":"Validation Error","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","example":"Label can't be blank","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["status","title","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"422","title":"Validation Error","detail":"Label can't be blank"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b31c2308-c4cf-410d-9e05-e9ff1943fbc1":{"bearer_auth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"95bee8d2-de0b-4a45-a759-17d5709dfb8a":{"url":"https://api.scholarlysoftware.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"openapi.json"},"subdomain":"scholarly","siteName":"Scholarly API Documentation","title":"Update a file - Scholarly API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T19:43:07.847Z","originalFileLocation":"api-reference/files/update-a-file.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a file\u0026#x27;s metadata or move it to a different folder. This endpoint can be used to: - Update the file name - Move the file to a different folder (must be owned by the same user) To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scholarly API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_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/scholarly/J0HSMTHFMSfEWK1a/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a file - Scholarly API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a file\u0026#x27;s metadata or move it to a different folder. This endpoint can be used to: - Update the file name - Move the file to a different folder (must be owned by the same user) To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scholarly API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scholarly.mintlify.site/_mintlify/api/og/v2?division=Files\u0026amp;title=Update+a+file\u0026amp;description=Update+a+file%27s+metadata+or+move+it+to+a+different+folder.%0A%0AThis+endpoint+can+be+used+to%3A%0A-+Update+the+file+name%0A-+Move+the+file+to+a+different+folder+%28must+be+\u0026amp;theme=b8378b6ec1397b5e89c94f14\u0026amp;signature=74adade8731e20c75a4a542274d3b9ce90c89ebeab94dded6497b037b1ddfa99\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a file - Scholarly API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a file\u0026#x27;s metadata or move it to a different folder. This endpoint can be used to: - Update the file name - Move the file to a different folder (must be owned by the same user) To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scholarly.mintlify.site/_mintlify/api/og/v2?division=Files\u0026amp;title=Update+a+file\u0026amp;description=Update+a+file%27s+metadata+or+move+it+to+a+different+folder.%0A%0AThis+endpoint+can+be+used+to%3A%0A-+Update+the+file+name%0A-+Move+the+file+to+a+different+folder+%28must+be+\u0026amp;theme=b8378b6ec1397b5e89c94f14\u0026amp;signature=74adade8731e20c75a4a542274d3b9ce90c89ebeab94dded6497b037b1ddfa99\">\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/scholarly/J0HSMTHFMSfEWK1a/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scholarly API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/files/update-a-file.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-docs.scholarlysoftware.com/#organization\",\"name\":\"Scholarly API Documentation\",\"url\":\"https://api-docs.scholarlysoftware.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://api-docs.scholarlysoftware.com#website\",\"name\":\"Scholarly API Documentation\",\"url\":\"https://api-docs.scholarlysoftware.com\",\"publisher\":{\"@id\":\"https://api-docs.scholarlysoftware.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file#webpage\",\"url\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file\",\"name\":\"Update a file\",\"description\":\"Update a file's metadata or move it to a different folder. This endpoint can be used to: - Update the file name - Move the file to a different folder (must be owned by the same user) To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\",\"dateModified\":\"2026-11-06T19:43:07.847Z\",\"isPartOf\":{\"@id\":\"https://api-docs.scholarlysoftware.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/list-additional-appointments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Core\",\"item\":\"https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/list-additional-appointments\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Files\",\"item\":\"https://api-docs.scholarlysoftware.com/api-reference/files/list-faculty-activity-files\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update a file\",\"item\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file#apireference\",\"headline\":\"Update a file\",\"name\":\"Update a file\",\"description\":\"Update a file's metadata or move it to a different folder. This endpoint can be used to: - Update the file name - Move the file to a different folder (must be owned by the same user) To confirm a direct upload, use POST /api/v1/files/:id/confirm instead.\",\"url\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file#webpage\"},\"dateModified\":\"2026-11-06T19:43:07.847Z\",\"publisher\":{\"@id\":\"https://api-docs.scholarlysoftware.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api-docs.scholarlysoftware.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Scholarly API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Scholarly API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/files/update-a-file.md","siteName":"Scholarly API Documentation","nav":{"global":null,"pages":[{"title":"Introduction","href":"/index"},{"title":"File Uploads","href":"/file-uploads"},{"title":"Inclusion of Related Resources","href":"/include"},{"title":"Filtering Faculty Activities by Integer Properties","href":"/faculty-activity-filters"},{"title":"Webhooks","href":"/webhooks"},{"group":"API reference","pages":[{"group":"Core","pages":[{"group":"Additional Appointments","pages":[{"title":"List additional appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/additional_appointments","href":"/api-reference/additional-appointments/list-additional-appointments"},{"title":"Create an additional appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/additional_appointments","href":"/api-reference/additional-appointments/create-an-additional-appointment"},{"title":"Get an additional appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/additional_appointments/{id}","href":"/api-reference/additional-appointments/get-an-additional-appointment"},{"title":"Update an additional appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/additional_appointments/{id}","href":"/api-reference/additional-appointments/update-an-additional-appointment"},{"title":"Delete an additional appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/additional_appointments/{id}","href":"/api-reference/additional-appointments/delete-an-additional-appointment"},{"title":"List additional appointments for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/additional_appointments","href":"/api-reference/additional-appointments/list-additional-appointments-for-a-profile"}]},{"group":"Addresses","pages":[{"title":"List addresses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/addresses","href":"/api-reference/addresses/list-addresses"},{"title":"Get an address","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/addresses/{id}","href":"/api-reference/addresses/get-an-address"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/addresses/{id}","href":"/api-reference/addresses/update-an-address"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/addresses/{id}","href":"/api-reference/addresses/delete-an-address"},{"title":"List addresses for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/addresses","href":"/api-reference/addresses/list-addresses-for-a-profile"},{"title":"Create an address for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/addresses","href":"/api-reference/addresses/create-an-address-for-a-profile"},{"title":"List addresses for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/addresses","href":"/api-reference/addresses/list-addresses-for-an-user"},{"title":"Create an address for an user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/users/{user_id}/addresses","href":"/api-reference/addresses/create-an-address-for-an-user"}]},{"group":"Admin Assistant Role Permissions","pages":[{"title":"List admin assistant role permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/admin_assistant_role_permissions","href":"/api-reference/admin-assistant-role-permissions/list-admin-assistant-role-permissions"},{"title":"Create an admin assistant role permission","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/admin_assistant_role_permissions","href":"/api-reference/admin-assistant-role-permissions/create-an-admin-assistant-role-permission"},{"title":"Get an admin assistant role permission","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/admin_assistant_role_permissions/{id}","href":"/api-reference/admin-assistant-role-permissions/get-an-admin-assistant-role-permission"},{"title":"Delete an admin assistant role permission","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/admin_assistant_role_permissions/{id}","href":"/api-reference/admin-assistant-role-permissions/delete-an-admin-assistant-role-permission"}]},{"group":"Admin Assistant Roles","pages":[{"title":"List admin assistant roles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/admin_assistant_roles","href":"/api-reference/admin-assistant-roles/list-admin-assistant-roles"},{"title":"Create an admin assistant role","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/admin_assistant_roles","href":"/api-reference/admin-assistant-roles/create-an-admin-assistant-role"},{"title":"Get an admin assistant role","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/admin_assistant_roles/{id}","href":"/api-reference/admin-assistant-roles/get-an-admin-assistant-role"},{"title":"Update an admin assistant role","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/admin_assistant_roles/{id}","href":"/api-reference/admin-assistant-roles/update-an-admin-assistant-role"},{"title":"Delete an admin assistant role","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/admin_assistant_roles/{id}","href":"/api-reference/admin-assistant-roles/delete-an-admin-assistant-role"},{"title":"List admin assistant roles for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/admin_assistant_roles","href":"/api-reference/admin-assistant-roles/list-admin-assistant-roles-for-an-user"}]},{"group":"Backups","pages":[{"title":"List backups","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/backups","href":"/api-reference/backups/list-backups"},{"title":"Create a backup","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/backups","href":"/api-reference/backups/create-a-backup"},{"title":"Get a backup","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/backups/{id}","href":"/api-reference/backups/get-a-backup"}]},{"group":"Campuses","pages":[{"title":"List campuses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campuses","href":"/api-reference/campuses/list-campuses"},{"title":"Create a campus","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campuses","href":"/api-reference/campuses/create-a-campus"},{"title":"Get a campus","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campuses/{id}","href":"/api-reference/campuses/get-a-campus"},{"title":"Update a campus","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/campuses/{id}","href":"/api-reference/campuses/update-a-campus"},{"title":"Delete a campus","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/campuses/{id}","href":"/api-reference/campuses/delete-a-campus"}]},{"group":"Credit Line Items","pages":[{"title":"List credit line items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/credit_line_items","href":"/api-reference/credit-line-items/list-credit-line-items"},{"title":"Get a credit line item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/credit_line_items/{id}","href":"/api-reference/credit-line-items/get-a-credit-line-item"},{"title":"Update a credit line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/credit_line_items/{id}","href":"/api-reference/credit-line-items/update-a-credit-line-item"},{"title":"Delete a credit line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/credit_line_items/{id}","href":"/api-reference/credit-line-items/delete-a-credit-line-item"},{"title":"List line items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/credits/line_items","href":"/api-reference/credit-line-items/list-line-items"},{"title":"Get a line item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/credits/line_items/{id}","href":"/api-reference/credit-line-items/get-a-line-item"},{"title":"Update a line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/credits/line_items/{id}","href":"/api-reference/credit-line-items/update-a-line-item"},{"title":"Delete a line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/credits/line_items/{id}","href":"/api-reference/credit-line-items/delete-a-line-item"},{"title":"List credit line items for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/credit_line_items","href":"/api-reference/credit-line-items/list-credit-line-items-for-a-profile"},{"title":"Create a credit line item for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/credit_line_items","href":"/api-reference/credit-line-items/create-a-credit-line-item-for-a-profile"},{"title":"List line items for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/credits/line_items","href":"/api-reference/credit-line-items/list-line-items-for-a-profile"},{"title":"Create a line item for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/credits/line_items","href":"/api-reference/credit-line-items/create-a-line-item-for-a-profile"}]},{"group":"Department Chairs","pages":[{"title":"List department chairs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/department_chairs","href":"/api-reference/department-chairs/list-department-chairs"},{"title":"Create a department chair","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/department_chairs","href":"/api-reference/department-chairs/create-a-department-chair"},{"title":"Get a department chair","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/department_chairs/{id}","href":"/api-reference/department-chairs/get-a-department-chair"},{"title":"Delete a department chair","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/department_chairs/{id}","href":"/api-reference/department-chairs/delete-a-department-chair"}]},{"group":"Departments","pages":[{"title":"List departments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments","href":"/api-reference/departments/list-departments"},{"title":"Create a department","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/departments","href":"/api-reference/departments/create-a-department"},{"title":"Get a department","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments/{id}","href":"/api-reference/departments/get-a-department"},{"title":"Update a department","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/departments/{id}","href":"/api-reference/departments/update-a-department"},{"title":"Delete a department","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/departments/{id}","href":"/api-reference/departments/delete-a-department"},{"title":"List child departments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments/{id}/children","href":"/api-reference/departments/list-child-departments"},{"title":"Get parent department","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments/{id}/parent","href":"/api-reference/departments/get-parent-department"},{"title":"List children relationship linkage","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments/{id}/relationships/children","href":"/api-reference/departments/list-children-relationship-linkage"},{"title":"Get parent relationship linkage","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/departments/{id}/relationships/parent","href":"/api-reference/departments/get-parent-relationship-linkage"},{"title":"Update parent relationship","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/departments/{id}/relationships/parent","href":"/api-reference/departments/update-parent-relationship"}]},{"group":"Employments","pages":[{"title":"List employments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/employments","href":"/api-reference/employments/list-employments"},{"title":"Get an employment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/employments/{id}","href":"/api-reference/employments/get-an-employment"},{"title":"Update an employment","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/employments/{id}","href":"/api-reference/employments/update-an-employment"},{"title":"Delete an employment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/employments/{id}","href":"/api-reference/employments/delete-an-employment"},{"title":"List employments for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/employments","href":"/api-reference/employments/list-employments-for-an-user"},{"title":"Create an employment for an user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/users/{user_id}/employments","href":"/api-reference/employments/create-an-employment-for-an-user"}]},{"group":"Faculty Activities","pages":[{"title":"List faculty activities","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/faculty_activities","href":"/api-reference/faculty-activities/list-faculty-activities"},{"title":"Create a faculty activity","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/faculty_activities","href":"/api-reference/faculty-activities/create-a-faculty-activity"},{"title":"Get a faculty activity","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/faculty_activities/{id}","href":"/api-reference/faculty-activities/get-a-faculty-activity"},{"title":"Update a faculty activity","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/faculty_activities/{id}","href":"/api-reference/faculty-activities/update-a-faculty-activity"},{"title":"Delete a faculty activity","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/faculty_activities/{id}","href":"/api-reference/faculty-activities/delete-a-faculty-activity"},{"title":"List faculty activities for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/faculty_activities","href":"/api-reference/faculty-activities/list-faculty-activities-for-a-profile"},{"title":"Create a faculty activity for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/faculty_activities","href":"/api-reference/faculty-activities/create-a-faculty-activity-for-a-profile"}]},{"group":"Faculty Activity Configurations","pages":[{"title":"List faculty activity configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/faculty_activity_configurations","href":"/api-reference/faculty-activity-configurations/list-faculty-activity-configurations"},{"title":"Get a faculty activity configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/faculty_activity_configurations/{id}","href":"/api-reference/faculty-activity-configurations/get-a-faculty-activity-configuration"}]},{"group":"File Upload Requests","pages":[{"title":"Create a file upload request in user's root folder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/file_upload_requests","href":"/api-reference/file-upload-requests/create-a-file-upload-request-in-users-root-folder"},{"title":"Confirm a file upload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/file_upload_requests/{id}/confirm","href":"/api-reference/file-upload-requests/confirm-a-file-upload"},{"title":"Create a file upload request (initiate direct upload)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/folders/{folder_id}/file_upload_requests","href":"/api-reference/file-upload-requests/create-a-file-upload-request-initiate-direct-upload"}]},{"group":"Files","pages":[{"title":"List faculty activity files","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/faculty_activities/{faculty_activity_id}/files","href":"/api-reference/files/list-faculty-activity-files"},{"title":"Upload a faculty activity file","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/faculty_activities/{faculty_activity_id}/files","href":"/api-reference/files/upload-a-faculty-activity-file"},{"title":"Delete a faculty activity file","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/faculty_activities/{faculty_activity_id}/files/{file_key}","href":"/api-reference/files/delete-a-faculty-activity-file"},{"title":"Get a file","description":"Returns details of a specific file","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/files/{id}","href":"/api-reference/files/get-a-file"},{"title":"Update a file","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/files/{id}","href":"/api-reference/files/update-a-file"},{"title":"Delete a file","description":"Deletes a file","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/files/{id}","href":"/api-reference/files/delete-a-file"},{"title":"List files for a folder","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{folder_id}/files","href":"/api-reference/files/list-files-for-a-folder"},{"title":"List files for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/files","href":"/api-reference/files/list-files-for-an-user"}]},{"group":"Folders","pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders","href":"/api-reference/folders/list-folders"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/folders","href":"/api-reference/folders/create-a-folder"},{"title":"Get a folder","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{id}","href":"/api-reference/folders/get-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/folders/{id}","href":"/api-reference/folders/update-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/folders/{id}","href":"/api-reference/folders/delete-a-folder"},{"title":"List child folders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{id}/children","href":"/api-reference/folders/list-child-folders"},{"title":"Get parent folder","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{id}/parent","href":"/api-reference/folders/get-parent-folder"},{"title":"List children relationship linkage","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{id}/relationships/children","href":"/api-reference/folders/list-children-relationship-linkage"},{"title":"Get parent relationship linkage","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/folders/{id}/relationships/parent","href":"/api-reference/folders/get-parent-relationship-linkage"},{"title":"Update parent relationship","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/folders/{id}/relationships/parent","href":"/api-reference/folders/update-parent-relationship"},{"title":"List folders for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/folders","href":"/api-reference/folders/list-folders-for-an-user"},{"title":"Create a folder for an user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/users/{user_id}/folders","href":"/api-reference/folders/create-a-folder-for-an-user"}]},{"group":"Institutions","pages":[{"title":"Get an institution","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/institution","href":"/api-reference/institutions/get-an-institution"}]},{"group":"Leaves","pages":[{"title":"List leaves","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leaves","href":"/api-reference/leaves/list-leaves"},{"title":"Get a leave","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leaves/{id}","href":"/api-reference/leaves/get-a-leave"},{"title":"Update a leave","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/leaves/{id}","href":"/api-reference/leaves/update-a-leave"},{"title":"Delete a leave","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/leaves/{id}","href":"/api-reference/leaves/delete-a-leave"},{"title":"List leaves for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/leaves","href":"/api-reference/leaves/list-leaves-for-a-profile"},{"title":"Create a leave for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/leaves","href":"/api-reference/leaves/create-a-leave-for-a-profile"}]},{"group":"Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/phone_numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Get a phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/phone_numbers/{id}","href":"/api-reference/phone-numbers/get-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/phone_numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-number"},{"title":"Delete a phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/phone_numbers/{id}","href":"/api-reference/phone-numbers/delete-a-phone-number"},{"title":"List phone numbers for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/phone_numbers","href":"/api-reference/phone-numbers/list-phone-numbers-for-a-profile"},{"title":"Create a phone number for a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles/{profile_id}/phone_numbers","href":"/api-reference/phone-numbers/create-a-phone-number-for-a-profile"},{"title":"List phone numbers for an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{user_id}/phone_numbers","href":"/api-reference/phone-numbers/list-phone-numbers-for-an-user"},{"title":"Create a phone number for an user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/users/{user_id}/phone_numbers","href":"/api-reference/phone-numbers/create-a-phone-number-for-an-user"}]},{"group":"Primary Appointments","pages":[{"title":"List primary appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/primary_appointments","href":"/api-reference/primary-appointments/list-primary-appointments"},{"title":"Create a primary appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/primary_appointments","href":"/api-reference/primary-appointments/create-a-primary-appointment"},{"title":"Get a primary appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/primary_appointments/{id}","href":"/api-reference/primary-appointments/get-a-primary-appointment"},{"title":"Update a primary appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/primary_appointments/{id}","href":"/api-reference/primary-appointments/update-a-primary-appointment"},{"title":"Delete a primary appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/primary_appointments/{id}","href":"/api-reference/primary-appointments/delete-a-primary-appointment"},{"title":"List primary appointments for a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{profile_id}/primary_appointments","href":"/api-reference/primary-appointments/list-primary-appointments-for-a-profile"}]},{"group":"Profiles","pages":[{"title":"List profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles","href":"/api-reference/profiles/list-profiles"},{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/profiles","href":"/api-reference/profiles/create-a-profile"},{"title":"Get a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profiles/{id}","href":"/api-reference/profiles/get-a-profile"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/profiles/{id}","href":"/api-reference/profiles/update-a-profile"},{"title":"Upload a profile avatar","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/profiles/{id}/avatar","href":"/api-reference/profiles/upload-a-profile-avatar"},{"title":"Delete a profile avatar","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/profiles/{id}/avatar","href":"/api-reference/profiles/delete-a-profile-avatar"},{"title":"Upload a profile CV","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/profiles/{id}/cv_upload","href":"/api-reference/profiles/upload-a-profile-cv"},{"title":"Delete a profile CV","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/profiles/{id}/cv_upload","href":"/api-reference/profiles/delete-a-profile-cv"},{"title":"Upload a profile preferred avatar","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/profiles/{id}/preferred_avatar","href":"/api-reference/profiles/upload-a-profile-preferred-avatar"},{"title":"Delete a profile preferred avatar","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/profiles/{id}/preferred_avatar","href":"/api-reference/profiles/delete-a-profile-preferred-avatar"}]},{"group":"Ranks","pages":[{"title":"List ranks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ranks","href":"/api-reference/ranks/list-ranks"},{"title":"Create a rank","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ranks","href":"/api-reference/ranks/create-a-rank"},{"title":"Get a rank","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ranks/{id}","href":"/api-reference/ranks/get-a-rank"},{"title":"Update a rank","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/ranks/{id}","href":"/api-reference/ranks/update-a-rank"},{"title":"Delete a rank","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/ranks/{id}","href":"/api-reference/ranks/delete-a-rank"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users","href":"/api-reference/users/list-users"},{"title":"Create an user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/users","href":"/api-reference/users/create-an-user"},{"title":"Get an user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/users/{id}","href":"/api-reference/users/get-an-user"},{"title":"Update an user","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/users/{id}","href":"/api-reference/users/update-an-user"}]},{"group":"Webhooks","pages":[{"title":"Additional appointment created","version":null,"deprecated":null,"openapi":"/openapi.json webhook additional_appointment.created","href":"/api-reference/webhooks/additional_appointment-created"},{"title":"Additional appointment deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook additional_appointment.deleted","href":"/api-reference/webhooks/additional_appointment-deleted"},{"title":"Additional appointment updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook additional_appointment.updated","href":"/api-reference/webhooks/additional_appointment-updated"},{"title":"Faculty activity created","version":null,"deprecated":null,"openapi":"/openapi.json webhook faculty_activity.created","href":"/api-reference/webhooks/faculty_activity-created"},{"title":"Faculty activity deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook faculty_activity.deleted","href":"/api-reference/webhooks/faculty_activity-deleted"},{"title":"Faculty activity updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook faculty_activity.updated","href":"/api-reference/webhooks/faculty_activity-updated"},{"title":"Department created","version":null,"deprecated":null,"openapi":"/openapi.json webhook department.created","href":"/api-reference/webhooks/department-created"},{"title":"Department deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook department.deleted","href":"/api-reference/webhooks/department-deleted"},{"title":"Department updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook department.updated","href":"/api-reference/webhooks/department-updated"},{"title":"Primary appointment created","version":null,"deprecated":null,"openapi":"/openapi.json webhook primary_appointment.created","href":"/api-reference/webhooks/primary_appointment-created"},{"title":"Primary appointment deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook primary_appointment.deleted","href":"/api-reference/webhooks/primary_appointment-deleted"},{"title":"Primary appointment updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook primary_appointment.updated","href":"/api-reference/webhooks/primary_appointment-updated"},{"title":"Profile created","version":null,"deprecated":null,"openapi":"/openapi.json webhook profile.created","href":"/api-reference/webhooks/profile-created"},{"title":"Profile deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook profile.deleted","href":"/api-reference/webhooks/profile-deleted"},{"title":"Profile updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook profile.updated","href":"/api-reference/webhooks/profile-updated"},{"title":"Profile related object updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook profile.related_object_updated","href":"/api-reference/webhooks/profile-related_object_updated"},{"title":"Rank created","version":null,"deprecated":null,"openapi":"/openapi.json webhook rank.created","href":"/api-reference/webhooks/rank-created"},{"title":"Rank deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook rank.deleted","href":"/api-reference/webhooks/rank-deleted"},{"title":"Rank updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook rank.updated","href":"/api-reference/webhooks/rank-updated"},{"title":"User created","version":null,"deprecated":null,"openapi":"/openapi.json webhook user.created","href":"/api-reference/webhooks/user-created"},{"title":"User deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook user.deleted","href":"/api-reference/webhooks/user-deleted"},{"title":"User updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook user.updated","href":"/api-reference/webhooks/user-updated"},{"title":"Workflows case created","version":null,"deprecated":null,"openapi":"/openapi.json webhook workflows_case.created","href":"/api-reference/webhooks/workflows_case-created"},{"title":"Workflows case deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook workflows_case.deleted","href":"/api-reference/webhooks/workflows_case-deleted"},{"title":"Workflows case updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook workflows_case.updated","href":"/api-reference/webhooks/workflows_case-updated"},{"title":"Workflows case completed","version":null,"deprecated":null,"openapi":"/openapi.json webhook workflows_case.completed","href":"/api-reference/webhooks/workflows_case-completed"},{"title":"Workflows case response completed","version":null,"deprecated":null,"openapi":"/openapi.json webhook workflows_case.response_completed","href":"/api-reference/webhooks/workflows_case-response_completed"},{"title":"Backup completed","version":null,"deprecated":null,"openapi":"/openapi.json webhook backup.completed","href":"/api-reference/webhooks/backup-completed"}]}]},{"group":"Course Evaluations","pages":[{"group":"Course Evaluation Courses","pages":[{"title":"List course evaluation courses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_courses","href":"/api-reference/course-evaluation-courses/list-course-evaluation-courses"},{"title":"Create a course evaluation course","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_courses","href":"/api-reference/course-evaluation-courses/create-a-course-evaluation-course"},{"title":"Get a course evaluation course","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_courses/{id}","href":"/api-reference/course-evaluation-courses/get-a-course-evaluation-course"},{"title":"Update a course evaluation course","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_courses/{id}","href":"/api-reference/course-evaluation-courses/update-a-course-evaluation-course"},{"title":"Delete a course evaluation course","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_courses/{id}","href":"/api-reference/course-evaluation-courses/delete-a-course-evaluation-course"}]},{"group":"Course Evaluation Instructors","pages":[{"title":"List course evaluation instructors","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_instructors","href":"/api-reference/course-evaluation-instructors/list-course-evaluation-instructors"},{"title":"Create a course evaluation instructor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_instructors","href":"/api-reference/course-evaluation-instructors/create-a-course-evaluation-instructor"},{"title":"Get a course evaluation instructor","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_instructors/{id}","href":"/api-reference/course-evaluation-instructors/get-a-course-evaluation-instructor"},{"title":"Delete a course evaluation instructor","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_instructors/{id}","href":"/api-reference/course-evaluation-instructors/delete-a-course-evaluation-instructor"}]},{"group":"Course Evaluation Listing Numbers","pages":[{"title":"List course evaluation listing numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_listing_numbers","href":"/api-reference/course-evaluation-listing-numbers/list-course-evaluation-listing-numbers"},{"title":"Create a course evaluation listing number","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_listing_numbers","href":"/api-reference/course-evaluation-listing-numbers/create-a-course-evaluation-listing-number"},{"title":"Get a course evaluation listing number","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_listing_numbers/{id}","href":"/api-reference/course-evaluation-listing-numbers/get-a-course-evaluation-listing-number"},{"title":"Update a course evaluation listing number","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_listing_numbers/{id}","href":"/api-reference/course-evaluation-listing-numbers/update-a-course-evaluation-listing-number"},{"title":"Delete a course evaluation listing number","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_listing_numbers/{id}","href":"/api-reference/course-evaluation-listing-numbers/delete-a-course-evaluation-listing-number"}]},{"group":"Course Evaluation Period Question Sets","pages":[{"title":"List course evaluation period question sets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_period_question_sets","href":"/api-reference/course-evaluation-period-question-sets/list-course-evaluation-period-question-sets"},{"title":"Create a course evaluation period question set","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_period_question_sets","href":"/api-reference/course-evaluation-period-question-sets/create-a-course-evaluation-period-question-set"},{"title":"Get a course evaluation period question set","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_period_question_sets/{id}","href":"/api-reference/course-evaluation-period-question-sets/get-a-course-evaluation-period-question-set"},{"title":"Update a course evaluation period question set","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_period_question_sets/{id}","href":"/api-reference/course-evaluation-period-question-sets/update-a-course-evaluation-period-question-set"},{"title":"Delete a course evaluation period question set","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_period_question_sets/{id}","href":"/api-reference/course-evaluation-period-question-sets/delete-a-course-evaluation-period-question-set"}]},{"group":"Course Evaluation Period Schedules","pages":[{"title":"List course evaluation period schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_period_schedules","href":"/api-reference/course-evaluation-period-schedules/list-course-evaluation-period-schedules"},{"title":"Get a course evaluation period schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_period_schedules/{id}","href":"/api-reference/course-evaluation-period-schedules/get-a-course-evaluation-period-schedule"},{"title":"Update a course evaluation period schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_period_schedules/{id}","href":"/api-reference/course-evaluation-period-schedules/update-a-course-evaluation-period-schedule"}]},{"group":"Course Evaluation Periods","pages":[{"title":"List course evaluation periods","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_periods","href":"/api-reference/course-evaluation-periods/list-course-evaluation-periods"},{"title":"Create a course evaluation period","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_periods","href":"/api-reference/course-evaluation-periods/create-a-course-evaluation-period"},{"title":"Get a course evaluation period","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_periods/{id}","href":"/api-reference/course-evaluation-periods/get-a-course-evaluation-period"},{"title":"Update a course evaluation period","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_periods/{id}","href":"/api-reference/course-evaluation-periods/update-a-course-evaluation-period"}]},{"group":"Course Evaluation Question Responses","pages":[{"title":"List course evaluation question responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_responses","href":"/api-reference/course-evaluation-question-responses/list-course-evaluation-question-responses"},{"title":"Get a course evaluation question response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_responses/{id}","href":"/api-reference/course-evaluation-question-responses/get-a-course-evaluation-question-response"},{"title":"Update a course evaluation question response","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_question_responses/{id}","href":"/api-reference/course-evaluation-question-responses/update-a-course-evaluation-question-response"}]},{"group":"Course Evaluation Question Set Responses","pages":[{"title":"List course evaluation question set responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_set_responses","href":"/api-reference/course-evaluation-question-set-responses/list-course-evaluation-question-set-responses"},{"title":"Get a course evaluation question set response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_set_responses/{id}","href":"/api-reference/course-evaluation-question-set-responses/get-a-course-evaluation-question-set-response"}]},{"group":"Course Evaluation Question Set Sections","pages":[{"title":"List course evaluation question set sections","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_set_sections","href":"/api-reference/course-evaluation-question-set-sections/list-course-evaluation-question-set-sections"},{"title":"Create a course evaluation question set section","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_question_set_sections","href":"/api-reference/course-evaluation-question-set-sections/create-a-course-evaluation-question-set-section"},{"title":"Get a course evaluation question set section","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_set_sections/{id}","href":"/api-reference/course-evaluation-question-set-sections/get-a-course-evaluation-question-set-section"},{"title":"Update a course evaluation question set section","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_question_set_sections/{id}","href":"/api-reference/course-evaluation-question-set-sections/update-a-course-evaluation-question-set-section"},{"title":"Delete a course evaluation question set section","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_question_set_sections/{id}","href":"/api-reference/course-evaluation-question-set-sections/delete-a-course-evaluation-question-set-section"}]},{"group":"Course Evaluation Question Sets","pages":[{"title":"List course evaluation question sets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_sets","href":"/api-reference/course-evaluation-question-sets/list-course-evaluation-question-sets"},{"title":"Create a course evaluation question set","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_question_sets","href":"/api-reference/course-evaluation-question-sets/create-a-course-evaluation-question-set"},{"title":"Get a course evaluation question set","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_sets/{id}","href":"/api-reference/course-evaluation-question-sets/get-a-course-evaluation-question-set"},{"title":"Update a course evaluation question set","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_question_sets/{id}","href":"/api-reference/course-evaluation-question-sets/update-a-course-evaluation-question-set"}]},{"group":"Course Evaluation Question Tags","pages":[{"title":"List course evaluation question tags","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_tags","href":"/api-reference/course-evaluation-question-tags/list-course-evaluation-question-tags"},{"title":"Create a course evaluation question tag","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_question_tags","href":"/api-reference/course-evaluation-question-tags/create-a-course-evaluation-question-tag"},{"title":"Get a course evaluation question tag","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_question_tags/{id}","href":"/api-reference/course-evaluation-question-tags/get-a-course-evaluation-question-tag"},{"title":"Update a course evaluation question tag","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_question_tags/{id}","href":"/api-reference/course-evaluation-question-tags/update-a-course-evaluation-question-tag"},{"title":"Delete a course evaluation question tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_question_tags/{id}","href":"/api-reference/course-evaluation-question-tags/delete-a-course-evaluation-question-tag"}]},{"group":"Course Evaluation Questions","pages":[{"title":"List course evaluation questions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_questions","href":"/api-reference/course-evaluation-questions/list-course-evaluation-questions"},{"title":"Create a course evaluation question","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_questions","href":"/api-reference/course-evaluation-questions/create-a-course-evaluation-question"},{"title":"Get a course evaluation question","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_questions/{id}","href":"/api-reference/course-evaluation-questions/get-a-course-evaluation-question"},{"title":"Update a course evaluation question","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_questions/{id}","href":"/api-reference/course-evaluation-questions/update-a-course-evaluation-question"},{"title":"Delete a course evaluation question","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_questions/{id}","href":"/api-reference/course-evaluation-questions/delete-a-course-evaluation-question"}]},{"group":"Course Evaluation Responses","pages":[{"title":"List course evaluation responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_responses","href":"/api-reference/course-evaluation-responses/list-course-evaluation-responses"},{"title":"Get a course evaluation response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_responses/{id}","href":"/api-reference/course-evaluation-responses/get-a-course-evaluation-response"},{"title":"Update a course evaluation response","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_responses/{id}","href":"/api-reference/course-evaluation-responses/update-a-course-evaluation-response"}]},{"group":"Course Evaluation Section Instructors","pages":[{"title":"List course evaluation section instructors","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_instructors","href":"/api-reference/course-evaluation-section-instructors/list-course-evaluation-section-instructors"},{"title":"Create a course evaluation section instructor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_section_instructors","href":"/api-reference/course-evaluation-section-instructors/create-a-course-evaluation-section-instructor"},{"title":"Get a course evaluation section instructor","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_instructors/{id}","href":"/api-reference/course-evaluation-section-instructors/get-a-course-evaluation-section-instructor"},{"title":"Delete a course evaluation section instructor","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_section_instructors/{id}","href":"/api-reference/course-evaluation-section-instructors/delete-a-course-evaluation-section-instructor"}]},{"group":"Course Evaluation Section Responses","pages":[{"title":"List course evaluation section responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_responses","href":"/api-reference/course-evaluation-section-responses/list-course-evaluation-section-responses"},{"title":"Get a course evaluation section response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_responses/{id}","href":"/api-reference/course-evaluation-section-responses/get-a-course-evaluation-section-response"}]},{"group":"Course Evaluation Section Students","pages":[{"title":"List course evaluation section students","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_students","href":"/api-reference/course-evaluation-section-students/list-course-evaluation-section-students"},{"title":"Create a course evaluation section student","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_section_students","href":"/api-reference/course-evaluation-section-students/create-a-course-evaluation-section-student"},{"title":"Get a course evaluation section student","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_section_students/{id}","href":"/api-reference/course-evaluation-section-students/get-a-course-evaluation-section-student"},{"title":"Delete a course evaluation section student","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_section_students/{id}","href":"/api-reference/course-evaluation-section-students/delete-a-course-evaluation-section-student"}]},{"group":"Course Evaluation Sections","pages":[{"title":"List course evaluation sections","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_sections","href":"/api-reference/course-evaluation-sections/list-course-evaluation-sections"},{"title":"Create a course evaluation section","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_sections","href":"/api-reference/course-evaluation-sections/create-a-course-evaluation-section"},{"title":"Get a course evaluation section","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_sections/{id}","href":"/api-reference/course-evaluation-sections/get-a-course-evaluation-section"},{"title":"Update a course evaluation section","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_sections/{id}","href":"/api-reference/course-evaluation-sections/update-a-course-evaluation-section"},{"title":"Delete a course evaluation section","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_sections/{id}","href":"/api-reference/course-evaluation-sections/delete-a-course-evaluation-section"}]},{"group":"Course Evaluation Students","pages":[{"title":"List course evaluation students","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_students","href":"/api-reference/course-evaluation-students/list-course-evaluation-students"},{"title":"Create a course evaluation student","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_students","href":"/api-reference/course-evaluation-students/create-a-course-evaluation-student"},{"title":"Get a course evaluation student","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_students/{id}","href":"/api-reference/course-evaluation-students/get-a-course-evaluation-student"},{"title":"Delete a course evaluation student","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_students/{id}","href":"/api-reference/course-evaluation-students/delete-a-course-evaluation-student"}]},{"group":"Course Evaluation Terms","pages":[{"title":"List course evaluation terms","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_terms","href":"/api-reference/course-evaluation-terms/list-course-evaluation-terms"},{"title":"Create a course evaluation term","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/course_evaluation_terms","href":"/api-reference/course-evaluation-terms/create-a-course-evaluation-term"},{"title":"Get a course evaluation term","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluation_terms/{id}","href":"/api-reference/course-evaluation-terms/get-a-course-evaluation-term"},{"title":"Update a course evaluation term","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/course_evaluation_terms/{id}","href":"/api-reference/course-evaluation-terms/update-a-course-evaluation-term"},{"title":"Delete a course evaluation term","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/course_evaluation_terms/{id}","href":"/api-reference/course-evaluation-terms/delete-a-course-evaluation-term"}]},{"group":"Course Evaluations","pages":[{"title":"List course evaluations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluations","href":"/api-reference/course-evaluations/list-course-evaluations"},{"title":"Get a course evaluation","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/course_evaluations/{id}","href":"/api-reference/course-evaluations/get-a-course-evaluation"}]}]},{"group":"Workflows","pages":[{"group":"Workflow Cases","pages":[{"title":"List workflow cases","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_cases","href":"/api-reference/workflow-cases/list-workflow-cases"},{"title":"Get a workflow case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_cases/{id}","href":"/api-reference/workflow-cases/get-a-workflow-case"},{"title":"List workflow cases for a workflow group","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_groups/{workflow_group_id}/workflow_cases","href":"/api-reference/workflow-cases/list-workflow-cases-for-a-workflow-group"}]},{"group":"Workflow Definitions","pages":[{"title":"List workflow definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_definitions","href":"/api-reference/workflow-definitions/list-workflow-definitions"},{"title":"Get a workflow definition","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_definitions/{id}","href":"/api-reference/workflow-definitions/get-a-workflow-definition"}]},{"group":"Workflow Groups","pages":[{"title":"Get a workflow group","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_groups/{id}","href":"/api-reference/workflow-groups/get-a-workflow-group"},{"title":"List children of a workflow group","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_groups/{id}/children","href":"/api-reference/workflow-groups/list-children-of-a-workflow-group"},{"title":"List workflow groups for a workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflows/{workflow_id}/workflow_groups","href":"/api-reference/workflow-groups/list-workflow-groups-for-a-workflow"}]},{"group":"Workflow Responses","pages":[{"title":"List workflow responses for a workflow case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_cases/{workflow_case_id}/workflow_responses","href":"/api-reference/workflow-responses/list-workflow-responses-for-a-workflow-case"},{"title":"List workflow responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_responses","href":"/api-reference/workflow-responses/list-workflow-responses"},{"title":"Get a workflow response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_responses/{id}","href":"/api-reference/workflow-responses/get-a-workflow-response"},{"title":"Download a workflow response's material","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_responses/{id}/materials/{material_id}","href":"/api-reference/workflow-responses/download-a-workflow-responses-material"}]},{"group":"Workflow Steps","pages":[{"title":"List workflow steps for a workflow definition","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_definitions/{workflow_definition_id}/workflow_steps","href":"/api-reference/workflow-steps/list-workflow-steps-for-a-workflow-definition"},{"title":"List workflow steps","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_steps","href":"/api-reference/workflow-steps/list-workflow-steps"},{"title":"Get a workflow step","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflow_steps/{id}","href":"/api-reference/workflow-steps/get-a-workflow-step"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/workflows/{id}","href":"/api-reference/workflows/get-a-workflow"}]}]}]}]},"basePath":"","title":"Update a file - Scholarly API Documentation","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}