{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Kadoa Documentation","colors":{"primary":"#ea580c","light":"#ea580c","dark":"#18181b"},"logo":{"light":"https://mintcdn.com/kadoa/dCOYM0EuffD9qYID/logo/kadoa-logo.svg?fit=max\u0026auto=format\u0026n=dCOYM0EuffD9qYID\u0026q=85\u0026s=344d5ae11cb3c2519a3c1541507ebed5","dark":"https://mintcdn.com/kadoa/dCOYM0EuffD9qYID/logo/kadoa-logo-dark.svg?fit=max\u0026auto=format\u0026n=dCOYM0EuffD9qYID\u0026q=85\u0026s=1fea0a0ce836a0d67d103f5e5adb6dda"},"favicon":"https://mintcdn.com/kadoa/A3sRkEG_6lnlmZD1/favicon.svg?fit=max\u0026auto=format\u0026n=A3sRkEG_6lnlmZD1\u0026q=85\u0026s=0cea8dbdde871424c4f413c68961c6e2","api":{"openapi":"https://api.kadoa.com/openapi"},"appearance":{"default":"light"},"background":{"color":{"light":"#fafaf9","dark":"#18181b"}},"navbar":{"primary":{"type":"button","label":"Open app","href":"https://kadoa.com/dashboard"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/kadoa","github":"https://github.com/kadoa-org"}},"seo":{"indexing":"all"},"fonts":{"family":"Kadoa Sans","weight":360,"source":"https://kadoa.b-cdn.net/fonts/KadoaSans-Variable.woff2","format":"woff2"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"duotone","name":"clock-rotate-left"},"href":"https://www.kadoa.com/changelog"},{"anchor":"Trust Center","icon":{"style":"duotone","name":"shield-check"},"href":"https://trust.kadoa.com"},{"anchor":"Contact Us","icon":{"style":"duotone","name":"envelope"},"href":"https://www.kadoa.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kadoa","hasAudioNarration":false,"actualSubdomain":"kadoa","customDomains":["docs.kadoa.com"],"gitSource":{"type":"github","owner":"kadoa-org","repo":"kadoa-backend","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3af94fe0d011f8977dcfa","collectionId":"0ac1f029-7a9b-4080-a1eb-2623e2de964b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3af94fe0d011f8977dcfa"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae3af94fe0d011f8977dcfa","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":152},{"language":"default","tag":"Documentation","count":62},{"language":"default","tag":"Workflows","count":20},{"language":"default","tag":"Build workflows","count":17},{"language":"default","tag":"Templates","count":16},{"language":"default","tag":"Notifications","count":13},{"language":"default","tag":"Integrations","count":12},{"language":"default","tag":"Agent","count":9},{"language":"default","tag":"Variables","count":7},{"language":"default","tag":"Administration","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body,html{font-weight:380}.font-bold,.font-semibold,.link,strong{font-weight:520}.sidebar-group-header,.sidebar-title{color:rgb(var(--primary));font-weight:600}body:has(.landing-cards) #page-title{font-size:2.5rem;line-height:1.15}.landing-cards{gap:1rem}.landing-cards a.card{margin:0;border-radius:.625rem;height:100%}.landing-cards a.card [data-component-part=card-content-container]{padding:0;display:flex;flex-direction:column;height:100%}.landing-cards a.card [data-component-part=card-icon]{margin:1.25rem 1.25rem 3.5rem}.landing-cards a.card [data-component-part=card-content-container]>div:has([data-component-part=card-title]){flex:1;border-top:1px solid rgb(9 9 11/.08)}.landing-cards a.card [data-component-part=card-title]{margin:0;padding:1rem 1.25rem 0}.landing-cards a.card [data-component-part=card-content]{margin:0;padding:.25rem 1.25rem 1.25rem;font-size:.9375rem;line-height:1.45}.dark .landing-cards a.card [data-component-part=card-content-container]>div:has([data-component-part=card-title]){border-top-color:rgb(255 255 255/.1)}body:has(.landing-cards) #content-area{max-width:68rem}.concept-list{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));column-gap:2.5rem;margin-top:1rem}.concept-list a{display:block;padding:.875rem 0;border-top:1px solid rgb(9 9 11/.08);text-decoration:none}.concept-name{display:block;color:rgb(24 24 27);font-weight:520}.concept-desc{display:block;margin-top:.125rem;color:rgb(113 113 122);font-size:.9375rem;line-height:1.45}.concept-list a:focus-visible .concept-name,.concept-list a:hover .concept-name{color:rgb(var(--primary))}.concept-list a:focus-visible{outline:2px solid rgb(var(--primary));outline-offset:2px;border-radius:.25rem}.dark .concept-list a{border-top-color:rgb(255 255 255/.1)}.dark .concept-name{color:rgb(244 244 245)}.dark .concept-desc{color:rgb(161 161 170)}@media (max-width:640px){.concept-list{grid-template-columns:minmax(0,1fr)}}@media (min-width:640px) and (max-width:1279px){.landing-cards{--cols:2!important}}.dark img[src$=\"/images/logos/cursor.svg\"],.dark img[src$=\"/images/logos/mcp.svg\"],.dark img[src$=\"/images/logos/openai.svg\"]{filter:invert(1)}"}],"page":{"pagePath":"api-reference/workflows/update-workflow-metadata","slug":"/api-reference/workflows/update-workflow-metadata","pageMetadata":{"openapi":"put /v4/workflows/{workflowId}/metadata","title":"Update workflow metadata","description":null,"href":"/api-reference/workflows/update-workflow-metadata"},"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":{"openapi":"put /v4/workflows/{workflowId}/metadata","title":"Update workflow metadata","description":null,"href":"/api-reference/workflows/update-workflow-metadata"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/kadoa/c67f9ac954426fc4/fonts.js"],"openApiReferenceData":{"operation":{"summary":"Update workflow metadata","tags":["Workflows"],"parameters":["efb448eb-8dcb-49f3-a740-e6987d7f9d1b"],"security":["7977fb48-f45f-41fd-9324-542163e9c61f"],"requestBody":"bc4f8ef3-0271-48b4-af9e-2385c91e15c4","responses":{"200":"abb5df2b-eaaf-4ffd-bbbc-1101c1b0f5c6","400":"f4f6f702-9c3a-4966-bc38-8eacdea9732d","401":"5b8d0bc8-3ffd-4aa6-a460-068abc7f7e0c","404":"abc9600c-eed9-45fb-83f7-8cef13255c05"},"method":"put","type":"path","servers":["b814b663-9a23-4ca5-a265-6fa681af04ee"],"path":"/v4/workflows/{workflowId}/metadata","baseUrlOptions":["https://api.kadoa.com"],"title":"Update workflow metadata","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"efb448eb-8dcb-49f3-a740-e6987d7f9d1b":{"name":"workflowId","in":"path","required":true,"description":"ID of the workflow to update","schema":{"type":"string","isRequired":true,"description":"ID of the workflow to update","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urls":{"type":"array","description":"List of target URLs for the workflow","items":{"type":"string","uniqueKey":"urls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"urls","typeLabel":"string[]"},"limit":{"oneOf":[{"type":"integer","minimum":1,"maximum":2147483647,"description":"Maximum records per run. Pass null to clear the limit and extract all rows.","uniqueKey":"limit.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":2147483647,"description":"Maximum records per run. Pass null to clear the limit and extract all rows.","uniqueKey":"limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"limit","typeLabel":"integer | null"},"updateInterval":{"type":"string","description":"The new update interval for the workflow","enum":["ONLY_ONCE","EVERY_10_MINUTES","HALF_HOURLY","HOURLY","THREE_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"uniqueKey":"updateInterval","typeLabel":"enum\u003cstring>"},"schedules":{"type":"array","items":{"type":"string","uniqueKey":"schedules.items.[INDEX]","typeLabel":"string"},"description":"Array of cron expressions for the workflow schedule","uniqueKey":"schedules","typeLabel":"string[]"},"timezone":{"type":"string","example":"America/New_York","description":"IANA timezone for cron schedules. A timezone-only update preserves existing cron expressions.","uniqueKey":"timezone","typeLabel":"string"},"name":{"type":"string","description":"The new name for the workflow","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"The new description for the workflow","uniqueKey":"description","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"The tags for the workflow","example":["tag1","tag2"],"uniqueKey":"tags","typeLabel":"string[]"},"location":{"type":"object","description":"The new location for the workflow","properties":{"type":{"type":"string","enum":["auto","manual"],"description":"Type of location selection","uniqueKey":"location.type","typeLabel":"enum\u003cstring>"},"isoCode":{"type":"string","description":"ISO code of the country (required when type is manual)","uniqueKey":"location.isoCode","typeLabel":"string"}},"uniqueKey":"location","typeLabel":"object"},"monitoring":{"type":"object","required":["fields"],"description":"The monitoring config for the workflow","properties":{"fields":{"type":"array","minItems":1,"items":{"type":"object","required":["fieldName","operator"],"properties":{"fieldName":{"type":"string","minLength":1,"description":"The name of the field to monitor","isRequired":true,"uniqueKey":"monitoring.fields.items.[INDEX].fieldName","typeLabel":"string"},"operator":{"type":"string","enum":["changed","added","removed"],"description":"The operator to use for monitoring","isRequired":true,"uniqueKey":"monitoring.fields.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"isKeyField":{"type":"boolean","description":"Optional explicit schema-key update for this field","uniqueKey":"monitoring.fields.items.[INDEX].isKeyField","typeLabel":"boolean"}},"uniqueKey":"monitoring.fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"monitoring.fields","typeLabel":"object[]"},"conditions":{"type":"object","required":["logicalOperator","conditions"],"description":"The conditions for monitoring","properties":{"logicalOperator":{"type":"string","enum":["AND","OR"],"description":"The logical operator to use for conditions","isRequired":true,"uniqueKey":"monitoring.conditions.logicalOperator","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","minItems":1,"items":{"type":"object","required":["type","operator"],"properties":{"type":{"type":"string","enum":["SINGLE","ANY"],"description":"Type of condition","isRequired":true,"uniqueKey":"monitoring.conditions.conditions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["MATCHES_REGEX","EQUALS","NOT_EQUALS","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL","IN","NOT_IN","BEFORE","AFTER","WITHIN_LAST_DAYS","IS_NULL","IS_NOT_NULL","IS_EMPTY","IS_NOT_EMPTY"],"description":"Condition operator","isRequired":true,"uniqueKey":"monitoring.conditions.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Field name (required for SINGLE type)","uniqueKey":"monitoring.conditions.conditions.items.[INDEX].field","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"Required except for null/empty operators","uniqueKey":"monitoring.conditions.conditions.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Required except for null/empty operators","uniqueKey":"monitoring.conditions.conditions.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Required except for null/empty operators","uniqueKey":"monitoring.conditions.conditions.items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"monitoring.conditions.conditions.items.[INDEX].value","typeLabel":"string | number | boolean"}},"uniqueKey":"monitoring.conditions.conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"monitoring.conditions.conditions","typeLabel":"object[]"}},"uniqueKey":"monitoring.conditions","typeLabel":"object"}},"uniqueKey":"monitoring","typeLabel":"object"},"entity":{"type":"string","description":"The new entity for the workflow","example":"job_posting","uniqueKey":"entity","typeLabel":"string"},"schema":{"type":"array","description":"The new extraction schema for the workflow","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"schema.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"schema.items.[INDEX].description","typeLabel":"string"},"example":{"type":"string","uniqueKey":"schema.items.[INDEX].example","typeLabel":"string"},"dataType":{"type":"string","enum":["STRING","NUMBER","BOOLEAN","DATE","DATETIME","MONEY","IMAGE","LINK","OBJECT","ARRAY"],"uniqueKey":"schema.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"isPrimaryKey":{"type":"boolean","uniqueKey":"schema.items.[INDEX].isPrimaryKey","typeLabel":"boolean"},"isRequired":{"type":"boolean","uniqueKey":"schema.items.[INDEX].isRequired","typeLabel":"boolean"},"isUnique":{"type":"boolean","uniqueKey":"schema.items.[INDEX].isUnique","typeLabel":"boolean"}},"uniqueKey":"schema.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schema","typeLabel":"object[]"},"additionalData":{"type":"object","description":"Additional static data for the workflow","uniqueKey":"additionalData","typeLabel":"object"},"userPrompt":{"type":"string","minLength":10,"maxLength":5000,"description":"Natural language instructions for the workflow.","uniqueKey":"userPrompt","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"urls":["\u003cstring>"],"limit":1073741824,"schedules":["\u003cstring>"],"timezone":"America/New_York","name":"\u003cstring>","description":"\u003cstring>","tags":["tag1","tag2"],"location":{"isoCode":"\u003cstring>"},"entity":"job_posting","schema":[{"name":"\u003cstring>","description":"\u003cstring>","example":"\u003cstring>","isPrimaryKey":true,"isRequired":true,"isUnique":true}],"additionalData":{},"userPrompt":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"abb5df2b-eaaf-4ffd-bbbc-1101c1b0f5c6":{"description":"Workflow metadata updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f4f6f702-9c3a-4966-bc38-8eacdea9732d":{"description":"Bad request (invalid input)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"5b8d0bc8-3ffd-4aa6-a460-068abc7f7e0c":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"abc9600c-eed9-45fb-83f7-8cef13255c05":{"description":"Workflow not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7977fb48-f45f-41fd-9324-542163e9c61f":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"b814b663-9a23-4ca5-a265-6fa681af04ee":{"url":"https://api.kadoa.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.kadoa.com/openapi"},"subdomain":"kadoa","siteName":"Kadoa Documentation","title":"Update workflow metadata - Kadoa Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T21:22:17.449Z","originalFileLocation":"api-reference/workflows/update-workflow-metadata.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=\"light\"}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=\"application-name\" content=\"Kadoa 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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_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/kadoa/WdUKDmwYX3I6vjmm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update workflow metadata - Kadoa Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kadoa Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kadoa.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Update+workflow+metadata\u0026amp;theme=afa28d6325190d37297991d8\u0026amp;signature=f34712b0012234c117e60cabebb25c912e9919f49a62cf39e5a55fce7d57b727\">\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 workflow metadata - Kadoa Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kadoa.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Update+workflow+metadata\u0026amp;theme=afa28d6325190d37297991d8\u0026amp;signature=f34712b0012234c117e60cabebb25c912e9919f49a62cf39e5a55fce7d57b727\">\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/kadoa/WdUKDmwYX3I6vjmm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kadoa Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ea580c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workflows/update-workflow-metadata.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kadoa.com/#organization\",\"name\":\"Kadoa Documentation\",\"url\":\"https://docs.kadoa.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kadoa/dCOYM0EuffD9qYID/logo/kadoa-logo.svg?fit=max\u0026auto=format\u0026n=dCOYM0EuffD9qYID\u0026q=85\u0026s=344d5ae11cb3c2519a3c1541507ebed5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kadoa.com#website\",\"name\":\"Kadoa Documentation\",\"url\":\"https://docs.kadoa.com\",\"publisher\":{\"@id\":\"https://docs.kadoa.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata#webpage\",\"url\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata\",\"name\":\"Update workflow metadata\",\"dateModified\":\"2026-10-26T21:22:17.449Z\",\"isPartOf\":{\"@id\":\"https://docs.kadoa.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.kadoa.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows\",\"item\":\"https://docs.kadoa.com/api-reference/workflows/get-workflow-data-by-id\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update workflow metadata\",\"item\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata#apireference\",\"headline\":\"Update workflow metadata\",\"name\":\"Update workflow metadata\",\"url\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata#webpage\"},\"dateModified\":\"2026-10-26T21:22:17.449Z\",\"publisher\":{\"@id\":\"https://docs.kadoa.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kadoa.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kadoa Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kadoa Documentation","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"duotone","name":"clock-rotate-left"},"href":"https://www.kadoa.com/changelog"},{"anchor":"Trust Center","icon":{"style":"duotone","name":"shield-check"},"href":"https://trust.kadoa.com"},{"anchor":"Contact Us","icon":{"style":"duotone","name":"envelope"},"href":"https://www.kadoa.com/contact"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Workflows","pages":[{"openapi":"get /v4/workflows/{workflowId}/data","title":"Get workflow data by ID","href":"/api-reference/workflows/get-workflow-data-by-id"},{"openapi":"get /v4/workflows/{workflowId}/data/export","title":"Create workflow data export","href":"/api-reference/workflows/create-workflow-data-export"},{"openapi":"get /v4/workflows/{workflowId}/data/exports/{exportId}","title":"Download workflow data export","href":"/api-reference/workflows/download-workflow-data-export"},{"openapi":"get /v4/workflows","title":"Get a list of workflows","href":"/api-reference/workflows/get-all-workflows"},{"openapi":"get /v4/workflows/{workflowId}","title":"Get workflow by ID","href":"/api-reference/workflows/get-workflow-by-id"},{"openapi":"get /v4/workflows/{workflowId}/connectors","title":"List destinations delivering this workflow's results","href":"/api-reference/workflows/list-workflow-connectors"},{"openapi":"post /v4/workflows","title":"Create a new workflow","href":"/api-reference/workflows/create-a-new-workflow"},{"openapi":"put /v4/workflows/{workflowId}/run","title":"Run a workflow","href":"/api-reference/workflows/run-a-workflow"},{"openapi":"put /v4/workflows/{workflowId}/schedule","title":"Schedule a workflow","description":null,"href":"/api-reference/workflows/schedule-a-workflow"},{"openapi":"put /v4/workflows/{workflowId}/metadata","title":"Update workflow metadata","href":"/api-reference/workflows/update-workflow-metadata"},{"openapi":"put /v4/workflows/{workflowId}/pause","title":"Pause a workflow","description":null,"href":"/api-reference/workflows/pause-a-workflow"},{"openapi":"delete /v4/workflows/{workflowId}","title":"Delete a workflow","href":"/api-reference/workflows/delete-a-workflow"},{"openapi":"put /v4/workflows/{workflowId}/resume","title":"Resume or unpause a workflow","href":"/api-reference/workflows/resume-a-workflow"},{"openapi":"get /v4/workflows/{workflowId}/history","title":"Get the workflow run history","href":"/api-reference/workflows/get-the-workflow-history"},{"openapi":"get /v4/workflows/{workflowId}/quality-metrics","title":"Get workflow quality metrics","href":"/api-reference/workflows/get-workflow-quality-metrics"},{"group":"Workflow Triggers","pages":[{"openapi":"get /v4/workflows/{workflowId}/triggers","title":"List workflow triggers","href":"/api-reference/workflows/list-workflow-triggers"},{"openapi":"post /v4/workflows/{workflowId}/triggers","title":"Create a workflow trigger","href":"/api-reference/workflows/create-workflow-trigger"},{"openapi":"get /v4/workflows/{workflowId}/triggers/{triggerId}","title":"Get a specific trigger","href":"/api-reference/workflows/get-workflow-trigger"},{"openapi":"patch /v4/workflows/{workflowId}/triggers/{triggerId}","title":"Update a trigger","href":"/api-reference/workflows/update-workflow-trigger"},{"openapi":"delete /v4/workflows/{workflowId}/triggers/{triggerId}","title":"Delete a trigger","href":"/api-reference/workflows/delete-workflow-trigger"}]}]},{"group":"Agent","pages":[{"title":"Create or continue an Agent session","openapi":"post /v5/agent","href":"/api-reference/assistant/create-or-continue-session"},{"title":"Send a Workflow Agent message","openapi":"post /v5/agent/workflows/{workflowId}/assistant/messages","href":"/api-reference/assistant/send-workflow-message"},{"title":"Get Workflow Agent timeline","openapi":"get /v5/agent/workflows/{workflowId}/timeline","href":"/api-reference/assistant/get-workflow-timeline"},{"title":"Get Agent pause state","openapi":"get /v5/agent/{sessionId}/pause-state","href":"/api-reference/assistant/get-pause-state"},{"title":"Answer an Agent question","openapi":"post /v5/agent/answer","href":"/api-reference/assistant/answer-question"},{"title":"Interrupt an Agent session","openapi":"post /v5/agent/{sessionId}/interrupt","href":"/api-reference/assistant/interrupt-session"},{"title":"Resume an Agent session","openapi":"post /v5/agent/{sessionId}/resume","href":"/api-reference/assistant/resume-session"},{"title":"Stop an Agent session","openapi":"post /v5/agent/{sessionId}/stop","href":"/api-reference/assistant/stop-session"},{"title":"Get Agent strategy","openapi":"get /v5/agent/data/{sessionId}/strategy","href":"/api-reference/assistant/get-strategy"}]},{"group":"Variables","pages":[{"openapi":"post /v4/variables/","title":"Create a variable","href":"/api-reference/variables/create-a-variable"},{"openapi":"get /v4/variables/","title":"List all variables","href":"/api-reference/variables/list-all-variables"},{"openapi":"get /v4/variables/{variableId}","title":"Get a variable","href":"/api-reference/variables/get-a-variable"},{"openapi":"patch /v4/variables/{variableId}","title":"Update a variable","href":"/api-reference/variables/update-a-variable"},{"openapi":"delete /v4/variables/{variableId}","title":"Delete a variable","href":"/api-reference/variables/delete-a-variable"}]},{"group":"Data Changes","pages":[{"openapi":"get /v4/changes","title":"Get all data changes","href":"/api-reference/monitoring/get-all-changes"},{"openapi":"get /v4/changes/{changeId}","title":"Get data change by ID","href":"/api-reference/monitoring/get-change-by-id"}]},{"group":"Notifications","pages":[{"openapi":"post /v5/notifications/channels","title":"Create a new notification channel","href":"/api-reference/notifications/create-notification-channel"},{"openapi":"post /v5/notifications/settings","title":"Create a new notification settings","href":"/api-reference/notifications/create-notification-settings"},{"openapi":"delete /v5/notifications/channels/{channelId}","title":"Delete a notification channel","href":"/api-reference/notifications/delete-notification-channel"},{"openapi":"delete /v5/notifications/settings/{settingsId}","title":"Delete a notification settings","href":"/api-reference/notifications/delete-notification-settings"},{"openapi":"get /v5/notifications/event-types/{eventType}","title":"Retrieve a specific event type details","href":"/api-reference/notifications/get-event-type"},{"openapi":"get /v5/notifications/event-types","title":"Retrieve all available notification event types","href":"/api-reference/notifications/get-event-types"},{"openapi":"get /v5/notifications/channels/{channelId}","title":"Retrieve a specific notification channel","href":"/api-reference/notifications/get-notification-channel"},{"openapi":"get /v5/notifications/channels","title":"Retrieve all notification channels","href":"/api-reference/notifications/get-notification-channels"},{"openapi":"get /v5/notifications/settings/{settingsId}","title":"Retrieve a specific notification settings","href":"/api-reference/notifications/get-notification-setting"},{"openapi":"get /v5/notifications/settings","title":"Retrieve all notification settings","href":"/api-reference/notifications/get-notification-settings"},{"openapi":"post /v5/notifications/test","title":"Test a notification settings with mock data","href":"/api-reference/notifications/test-notifications"},{"openapi":"put /v5/notifications/channels/{channelId}","title":"Update a notification channel","href":"/api-reference/notifications/update-notification-channel"},{"openapi":"put /v5/notifications/settings/{settingsId}","title":"Update a notification settings","href":"/api-reference/notifications/update-notification-settings"}]},{"group":"Schemas","pages":[{"openapi":"get /v4/schemas/","title":"List all schemas","href":"/api-reference/schemas/get-all-schemas"},{"openapi":"get /v4/schemas/{schemaId}","title":"Get schema by ID","href":"/api-reference/schemas/get-schema-by-id"},{"openapi":"post /v4/schemas/","title":"Create new schema","href":"/api-reference/schemas/create-schema"},{"openapi":"put /v4/schemas/{schemaId}","title":"Update existing schema","href":"/api-reference/schemas/update-schema"},{"openapi":"delete /v4/schemas/{schemaId}","title":"Delete schema","href":"/api-reference/schemas/delete-schema"}]},{"group":"Locations","pages":[{"openapi":"get /v4/locations","title":"Get all available locations","href":"/api-reference/locations/get-all-locations"}]},{"group":"Data Quality","pages":[{"title":"Get data quality rules","openapi":"get /v4/workflows/{workflowId}/schema-validation-rules","href":"/api-reference/data-quality/get-rules"},{"title":"Upsert data quality rules","openapi":"put /v4/workflows/{workflowId}/schema-validation-rules","href":"/api-reference/data-quality/upsert-rules"},{"title":"Delete data quality rules for a field","openapi":"delete /v4/workflows/{workflowId}/schema-validation-rules/{fieldName}","href":"/api-reference/data-quality/delete-field-rules"}]},{"group":"Templates","pages":[{"title":"List templates","openapi":"get /v4/templates/","href":"/api-reference/templates/list-templates"},{"title":"Get template","openapi":"get /v4/templates/{templateId}","href":"/api-reference/templates/get-template"},{"title":"Create template","openapi":"post /v4/templates/","href":"/api-reference/templates/create-template"},{"title":"Update template","openapi":"put /v4/templates/{templateId}","href":"/api-reference/templates/update-template"},{"title":"Delete template","openapi":"delete /v4/templates/{templateId}","href":"/api-reference/templates/delete-template"},{"title":"Create template version","openapi":"post /v4/templates/{templateId}/versions","href":"/api-reference/templates/create-version"},{"title":"List template schemas","openapi":"get /v4/templates/{templateId}/schemas","href":"/api-reference/templates/list-schemas"},{"title":"List template workflows","openapi":"get /v4/templates/{templateId}/workflows","href":"/api-reference/templates/list-workflows"},{"title":"Apply template update","openapi":"post /v4/templates/{templateId}/apply","href":"/api-reference/templates/apply-update"},{"title":"Preview schema change","openapi":"post /v4/templates/{templateId}/preview-schema-change","href":"/api-reference/templates/preview-schema-change"},{"title":"Link workflows to template","openapi":"post /v4/templates/{templateId}/link","href":"/api-reference/templates/link-workflows"},{"title":"Unlink workflows from template","openapi":"post /v4/templates/{templateId}/unlink","href":"/api-reference/templates/unlink-workflows"},{"title":"Save workflow as template","openapi":"post /v4/templates/from-workflow","href":"/api-reference/templates/save-from-workflow"}]},{"group":"Support","pages":[{"title":"List support issues","openapi":"get /v4/support/issues","href":"/api-reference/support/get-support-issues"},{"title":"Create support issue","openapi":"post /v4/support/issues","href":"/api-reference/support/create-support-issue"},{"title":"Update support issue","openapi":"patch /v4/support/issues/{issueId}","href":"/api-reference/support/update-support-issue"},{"title":"Get issue states","openapi":"get /v4/support/states","href":"/api-reference/support/get-support-states"}]}]}]}]},"basePath":"","title":"Update workflow metadata - Kadoa Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}