{
"message": "The request could not be processed. Check the request body and required parameters."
}
{
"message": "unauthorized"
}
{
"status": "InternalServerError",
"code": 500,
"messages": [
"Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}
Documents
Partial Update
Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.
Keyed by engine field names (case-sensitive). Typical keys: Title, Url, Description, Category, Date, Language, Content. Only string values in this API shape.
Optional document kind. Sibling of id and fields (not inside fields). Defaults to "PageContent"; use "FileContent" for files such as PDFs or DOCX so they are treated as file results in the index.
Per-row outcome; check when batching many documents.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cludo API Documentation","colors":{"primary":"#5B4EFF","light":"#8B7FFF","dark":"#3D2ECC"},"logo":{"light":"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f","dark":"https://mintcdn.com/cludo/QSqg9vB71E-uhtLM/images/Cludo_New_2021_White-01.png?fit=max\u0026auto=format\u0026n=QSqg9vB71E-uhtLM\u0026q=85\u0026s=96205b256cd0af679f7ed7cd6a7a9445"},"favicon":"https://mintcdn.com/cludo/PNai9WMfBGw4gQ9V/images/Cludo_Site_Icon.png?fit=max\u0026auto=format\u0026n=PNai9WMfBGw4gQ9V\u0026q=85\u0026s=2658cbf2e4ea92bc14f7210485c60b4c","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","python","javascript","typescript"],"prefill":true},"mdx":{"server":["https://api.cludo.com","https://api-us1.cludo.com"]}},"background":{"decoration":"gradient","color":{"light":"#f2f4f7"}},"navbar":{"links":[{"href":"https://cludo.com/resources/contact-support/","label":"Support"}],"primary":{"type":"button","label":"MyCludo","href":"https://my.cludo.com"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Support","href":"https://cludo.com/resources/contact-support"},{"label":"Status","href":"https://status.cludo.com"}]}]},"search":{},"fonts":{"family":"Poppins"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cludo","hasAudioNarration":false,"actualSubdomain":"cludo","customDomains":["docs.cludo.com"],"gitSource":{"type":"github","owner":"cludo","repo":"cludo-api-documentation-2026","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7582aee7653c65618e8c1","collectionId":"ee5697fb-ff48-4ada-9c32-bcbb28abed93","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7582aee7653c65618e8c1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad7582aee7653c65618e8c1","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Search Tools","count":22},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Quicklinks","count":7},{"language":"default","tag":"AI","count":6},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Content \u0026 Indexing","count":5},{"language":"default","tag":"Banners","count":5},{"language":"default","tag":"Page Rankings","count":5},{"language":"default","tag":"Get Started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@cludo.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles/custom.css","content":"body{color:#000000}"}],"page":{"pagePath":"api-reference/partial-update","slug":"/api-reference/partial-update","pageMetadata":{"title":"Partial Update","description":"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\"\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":"Partial Update","description":"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"partialUpdateDocuments","summary":"Partial Update","description":"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.","security":["ff2ff236-71e9-4936-a8fc-b8adcc110117"],"parameters":["cba64fb3-7232-4b45-828b-e037b53c6f29","1b629adc-dd12-4aff-acde-51c182ba5b64"],"requestBody":"2d0f519b-d25b-4315-bf43-aea7e51fbe71","responses":{"200":"b1e6eebd-e895-4b6d-9782-704712f84500","400":"ed5e7f9a-df71-46c6-9e6c-c226ad4356e1","401":"7723fb44-26f7-42df-b2e1-4296fac8dfb0","500":"97092718-7ba2-4af6-806e-ab627d0cbe00"},"method":"patch","type":"path","servers":["6df15074-496a-4eb7-925a-fac5844fd2bf","0fbef69d-1258-4532-8e61-343b5cd2622a"],"path":"/api/v4/{customerId}/index/{crawlerId}/documents","baseUrlOptions":["https://api.cludo.com","https://api-us1.cludo.com"],"title":"Partial Update","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.items.0.id":"\u003cstring>","body.items.0.type":"PageContent"}]},"dependencies":{"parameters":{"cba64fb3-7232-4b45-828b-e037b53c6f29":{"name":"customerId","in":"path","required":true,"description":"Your Cludo Customer ID (same as in MyCludo and Basic auth username).","schema":{"type":"integer","isRequired":true,"description":"Your Cludo Customer ID (same as in MyCludo and Basic auth username).","uniqueKey":"","typeLabel":"integer"}},"1b629adc-dd12-4aff-acde-51c182ba5b64":{"name":"crawlerId","in":"path","required":true,"description":"Crawler (content source) ID from MyCludo. ","schema":{"type":"integer","isRequired":true,"description":"Crawler (content source) ID from MyCludo. ","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","description":"Stable unique key for upserts and deletes—most integrations use the canonical page URL.","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].fields.additionalProperties","typeLabel":"string"},"description":"Keyed by **engine field names** (case-sensitive). Typical keys: `Title`, `Url`, `Description`, `Category`, `Date`, `Language`, `Content`. Only string values in this API shape.","isRequired":true,"uniqueKey":"items.[INDEX].fields","typeLabel":"object"},"type":{"type":"string","enum":["PageContent","FileContent"],"default":"PageContent","description":"Optional document kind. Sibling of `id` and `fields` (not inside `fields`). Defaults to `\"PageContent\"`; use `\"FileContent\"` for files such as PDFs or DOCX so they are treated as file results in the index.","uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"\u003cstring>","fields":{},"type":"PageContent"}]}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b1e6eebd-e895-4b6d-9782-704712f84500":{"description":"Documents updated successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"string","description":"Echo of the document id after indexing.","uniqueKey":"items.[INDEX].document.id","typeLabel":"string"},"type":{"type":"integer","description":"Document kind: 0 = PageContent, 1 = FileContent. Echoes the value sent on push (defaulting to 0).","uniqueKey":"items.[INDEX].document.type","typeLabel":"integer"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].document.fields.additionalProperties","typeLabel":"string"},"description":"Fields stored for this document after the operation.","uniqueKey":"items.[INDEX].document.fields","typeLabel":"object"}},"uniqueKey":"items.[INDEX].document","typeLabel":"object"},"reason":{"type":"string","description":"Success message (e.g. “Index succeed”) or failure detail.","uniqueKey":"items.[INDEX].reason","typeLabel":"string"},"success":{"type":"boolean","description":"Per-row outcome; check when batching many documents.","uniqueKey":"items.[INDEX].success","typeLabel":"boolean"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"document":{"id":"\u003cstring>","type":123,"fields":{}},"reason":"\u003cstring>","success":true}]}},"exampleType":"generated"}},"exampleType":"generated"},"ed5e7f9a-df71-46c6-9e6c-c226ad4356e1":{"description":"The request is invalid. This typically occurs due to missing required fields, incorrect parameter values, or malformed request body.","content":{"application/json":{"schema":{"type":"object","description":"Error response returned when a request fails.","properties":{"message":{"type":"string","description":"A message describing what went wrong.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The request could not be processed. Check the request body and required parameters."},"examples":{"Example":{"title":"Example","value":{"message":"The request could not be processed. Check the request body and required parameters."}}},"exampleType":"examples"}},"exampleType":"examples"},"7723fb44-26f7-42df-b2e1-4296fac8dfb0":{"description":"Authentication failed. The Authorization header is missing or contains invalid credentials.","content":{"application/json":{"schema":{"type":"object","description":"Returned when authentication fails.","properties":{"message":{"type":"string","description":"Authentication failure reason.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"message":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"97092718-7ba2-4af6-806e-ab627d0cbe00":{"description":"An unexpected server error occurred. If this persists, contact support@cludo.com.","content":{"application/json":{"schema":{"type":"object","description":"Returned when an unexpected server error occurs.","properties":{"status":{"type":"string","description":"HTTP status name.","uniqueKey":"status","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code.","uniqueKey":"code","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX]","typeLabel":"string"},"description":"Error details, usually including a support reference id.","uniqueKey":"messages","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"examples":{"Example":{"title":"Example","value":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ff2ff236-71e9-4936-a8fc-b8adcc110117":{"BasicAuth":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]}}},"servers":{"6df15074-496a-4eb7-925a-fac5844fd2bf":{"url":"https://api.cludo.com","description":"EU region (Customer IDs below 10,000,000)"},"0fbef69d-1258-4532-8e61-343b5cd2622a":{"url":"https://api-us1.cludo.com","description":"US region (Customer IDs 10,000,000 and above)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/index-management.json"},"subdomain":"cludo","siteName":"Cludo API Documentation","title":"Partial Update - Cludo API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-08T14:48:31.815Z","originalFileLocation":"api-reference/partial-update.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=\"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cludo 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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Partial Update - Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cludo.com/api-reference/partial-update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Partial+Update\u0026amp;description=Updates+only+the+fields+you+send+for+each+document.+Request+body+is+a+JSON+array+of+document+objects+in+the+same+shape+as+replace%3B+omit+fields+you+do+not+want+t\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=ab4cc99c3528a1bb12e0ec3808d6a1238a83a75ecff57474515340e37ff858e8\">\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=\"Partial Update - Cludo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Partial+Update\u0026amp;description=Updates+only+the+fields+you+send+for+each+document.+Request+body+is+a+JSON+array+of+document+objects+in+the+same+shape+as+replace%3B+omit+fields+you+do+not+want+t\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=ab4cc99c3528a1bb12e0ec3808d6a1238a83a75ecff57474515340e37ff858e8\">\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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cludo.com/api-reference/partial-update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/partial-update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cludo.com/#organization\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cludo.com#website\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cludo.com/api-reference/partial-update#webpage\",\"url\":\"https://docs.cludo.com/api-reference/partial-update\",\"name\":\"Partial Update\",\"description\":\"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\",\"dateModified\":\"2026-07-08T14:48:31.815Z\",\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cludo.com/api-reference/partial-update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cludo.com/api-reference/partial-update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Content \u0026 Indexing\",\"item\":\"https://docs.cludo.com/api-reference/create-or-replace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.cludo.com/api-reference/create-or-replace\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Partial Update\",\"item\":\"https://docs.cludo.com/api-reference/partial-update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cludo.com/api-reference/partial-update#apireference\",\"headline\":\"Partial Update\",\"name\":\"Partial Update\",\"description\":\"Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.\",\"url\":\"https://docs.cludo.com/api-reference/partial-update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cludo.com/api-reference/partial-update#webpage\"},\"dateModified\":\"2026-07-08T14:48:31.815Z\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cludo API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cludo API Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/api-reference/overview"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /api/v4/{customerId}/{engineId}/search","href":"/api-reference/v4/search/search"},{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","href":"/api-reference/v4/search/autocomplete"}]},{"group":"AI","pages":[{"title":"AI Search Overview","href":"/api-reference/v4/ai/overview"},{"group":"AI Chat","pages":[{"title":"AI Chat","openapi":"POST /api/v4/{customerId}/{engineId}/search/answer","href":"/api-reference/v4/ai/chat"},{"title":"AI Chat Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/feedback","href":"/api-reference/ai-chat-feedback"},{"title":"AI Chat Click","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/click","href":"/api-reference/ai-chat-click"}]},{"group":"AI Summary","pages":[{"title":"AI Summary","openapi":"POST /api/v4/{customerId}/{engineId}/search/summarize","href":"/api-reference/v4/ai/summary"},{"title":"AI Summary Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/summarize/feedback","href":"/api-reference/ai-summary-feedback"}]}]},{"group":"Content \u0026 Indexing","pages":[{"group":"Documents","pages":[{"title":"Create or Replace","description":"Create new documents or fully replace existing ones in the index. Send a JSON array of document objects; each document must include an `id` and a `fields` object. Common field names include Title, Url, Description, Date, Category, and Language.","deprecated":null,"version":null,"openapi":"/openapi/index-management.json put /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/create-or-replace"},{"title":"Partial Update","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update"},{"title":"Single Delete","description":"Deletes one document from the index by its document ID, supplied as the required `documentId` query parameter.\n\nThe document ID is the same value you used as `id` when indexing the document. For most integrations this is the document's **canonical URL** (e.g. `https://example.com/products/widget-pro`), not an internal numeric key.\n\nWhen the document ID contains reserved characters — which a full URL typically does (`?`, `\u0026`, `=`, `#`, spaces) — URL-encode it before adding it to the query string so it is parsed correctly (e.g. `documentId=https%3A%2F%2Fexample.com%2Fproducts%2Fwidget-pro`).","deprecated":null,"version":null,"openapi":"/openapi/index-management.json delete /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/single-delete"},{"title":"Bulk Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete","href":"/api-reference/bulk-delete"}]},{"group":"Crawlers","pages":[{"title":"Queue URLs","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/crawler/{crawlerId}/paths","href":"/api-reference/queue-urls"}]}]},{"group":"Tracking","pages":[{"title":"Track Search Query","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/querylog","href":"/api-reference/track-search-query"},{"title":"Track Result Click","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/clicklog","href":"/api-reference/track-result-click"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","deprecated":null,"version":null,"openapi":"/openapi/feedback.json post /api/v4/{customerId}/{engineId}/feedback","href":"/api-reference/submit-feedback"}]},{"group":"Search Tools","pages":[{"title":"Pre-search Suggestions","href":"/api-reference/v4/search-tools/pre-search-suggestions"},{"group":"Banners","pages":[{"title":"Create Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner"},{"title":"List Banners by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine"},{"title":"Get Single Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/{bannerId}","href":"/api-reference/get-single-banner"},{"title":"Update Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/banners/{bannerId}","href":"/api-reference/update-banner"},{"title":"Delete Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/banners/{bannerId}","href":"/api-reference/delete-banner"}]},{"group":"Page Rankings","pages":[{"title":"Create Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/rankings","href":"/api-reference/create-ranking"},{"title":"List Rankings by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/site/{engineId}","href":"/api-reference/list-rankings-by-engine"},{"title":"Get Single Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/{rankingId}","href":"/api-reference/get-single-ranking"},{"title":"Update Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/rankings/{rankingId}","href":"/api-reference/update-ranking"},{"title":"Delete Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/rankings/{rankingId}","href":"/api-reference/delete-ranking"}]},{"group":"Quicklinks","pages":[{"title":"Quicklinks","href":"/api-reference/v4/search-tools/quicklinks"},{"title":"Create Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/quicklinks","href":"/api-reference/create-quicklink"},{"title":"List Quicklinks","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinks","href":"/api-reference/list-quicklinks"},{"title":"Get Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/quicklinks/{quicklinkId}","href":"/api-reference/get-quicklink"},{"title":"Get Quicklinks by Terms","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinkterms","href":"/api-reference/get-quicklinks-by-terms"},{"title":"Update Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/quicklinks/{quicklinkId}","href":"/api-reference/update-quicklink"},{"title":"Delete Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/quicklinks/{quicklinkId}","href":"/api-reference/delete-quicklink"}]},{"group":"Synonyms","pages":[{"title":"Create Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/synonymsgroup","href":"/api-reference/create-synonym-group"},{"title":"Get Synonyms by Language or Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/synonymsgroup/{identifier}","href":"/api-reference/get-synonyms-by-language-or-synonym-group"},{"title":"Update Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/synonymsgroup","href":"/api-reference/update-synonym-group"},{"title":"Delete Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/synonymsgroup","href":"/api-reference/delete-synonym-group"}]}]}]}]},"basePath":"","title":"Partial Update - Cludo API Documentation","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}