A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model. Set it to an empty string to fall back to the name.
A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model, and empty when unset — display the name in that case.
Messages to display during function execution lifecycle events.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vogent","colors":{"primary":"#1E4CFE","light":"#5476FF","dark":"#1E4CFE"},"logo":{"light":"https://mintcdn.com/elto-1/ooEImm5m-H0BmxUg/logo/light.svg?fit=max\u0026auto=format\u0026n=ooEImm5m-H0BmxUg\u0026q=85\u0026s=4bdeb0d3b2f061ef727c095d1cbccfeb","dark":"https://mintcdn.com/elto-1/ooEImm5m-H0BmxUg/logo/dark.svg?fit=max\u0026auto=format\u0026n=ooEImm5m-H0BmxUg\u0026q=85\u0026s=9cb454e44058d36d3032ca5b13a24149"},"favicon":"https://mintcdn.com/elto-1/ooEImm5m-H0BmxUg/favicon.svg?fit=max\u0026auto=format\u0026n=ooEImm5m-H0BmxUg\u0026q=85\u0026s=fe8097933a06b6ccbc33f7a037cdfc12","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"href":"mailto:jagath@vogent.ai","label":"Support"},{"href":"https://discord.gg/An5z6xhYfS","label":"Discord"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.vogent.ai"}},"footer":{"socials":{"twitter":"https://x.com/vogentai","linkedin":"https://www.linkedin.com/company/vogent","discord":"https://discord.gg/An5z6xhYfS"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"elto-1","hasAudioNarration":false,"actualSubdomain":"elto-1","customDomains":["docs.vogent.ai"],"gitSource":{"type":"github","owner":"elto-docs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a9090481fe68a4588ff7384","collectionId":"8c91267b-dcd1-49cc-816c-773c5f71e96f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a9090481fe68a4588ff7384"},"entitlements":{},"buildId":"6a9090481fe68a4588ff7384","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":57},{"language":"default","tag":"Guides","count":50},{"language":"default","tag":"Platform Overview","count":26},{"language":"default","tag":"Agents","count":18},{"language":"default","tag":"Voicelab","count":17},{"language":"default","tag":"Phone Numbers","count":13},{"language":"default","tag":"For Developers","count":10},{"language":"default","tag":"Eval Runs","count":7},{"language":"default","tag":"Batch Dials","count":7},{"language":"default","tag":"Webhooks","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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/update-function","slug":"/api-reference/update-function","pageMetadata":{"openapi":"put /functions/{id}","title":"Update function","description":"Updates a specific function.","href":"/api-reference/update-function"},"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 a specific function.\"\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":{"openapi":"put /functions/{id}","title":"Update function","description":"Updates a specific function.","href":"/api-reference/update-function"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update function","description":"Updates a specific function.","operationId":"updateFunction","requestBody":"d984f983-a008-454b-9efc-196540d8063f","responses":{"200":"dbccdcb7-880a-4285-8d18-b06282269aed","400":"1aadc50b-0338-484c-88c9-1988e56ee396","422":"7015ff81-b88c-4583-8651-0c259f6552f5"},"method":"put","type":"path","servers":["b09f045b-12f8-4298-8576-2f7cd9d22cec"],"security":["02d4cac2-c08d-4613-ad1d-fdfdb10be0db"],"path":"/functions/{id}","baseUrlOptions":["https://api.vogent.ai/api"],"title":"Update function","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ec8d64c2-6b32-4797-9d44-c0037f4ebaf5":{"in":"path","name":"id","schema":{"type":"string","isRequired":true,"description":"ID of the function.","uniqueKey":"","typeLabel":"string"},"required":true,"description":"ID of the function."}},"requestBody":{"description":"Update function properties","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Transfer","required":["allowedNumbers"],"properties":{"allowedNumbers":{"type":"array","description":"The numbers that the agent is allowed to transfer to.","items":{"type":"object","properties":{"number":{"type":"string","nullable":false,"description":"The number in e.164 format.","isRequired":true,"uniqueKey":"oneOf.0.allowedNumbers.items.[INDEX].number","typeLabel":"string"}},"required":["number"],"uniqueKey":"oneOf.0.allowedNumbers.items.[INDEX]","typeLabel":"object"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.allowedNumbers","typeLabel":"object[]"},"name":{"type":"string","description":"The name of the function.","nullable":false,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"displayName":{"type":"string","description":"A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model. Set it to an empty string to fall back to the name.","nullable":false,"uniqueKey":"oneOf.0.displayName","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does.","nullable":false,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"type":{"type":"string","enum":["transfer","api"],"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"lifecycleMessages":{"type":"object","properties":{"started":{"type":"array","description":"Messages to display when the function starts executing. One will be chosen at random.","items":{"type":"string","uniqueKey":"oneOf.0.lifecycleMessages.started.items.[INDEX]","typeLabel":"string"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.lifecycleMessages.started","typeLabel":"string[]"},"waiting":{"type":"array","description":"Messages to play while the function is still running and the model returned StillWaiting. One will be chosen at random. If empty, a built-in default set of English phrases is used.","items":{"type":"string","uniqueKey":"oneOf.0.lifecycleMessages.waiting.items.[INDEX]","typeLabel":"string"},"nullable":false,"uniqueKey":"oneOf.0.lifecycleMessages.waiting","typeLabel":"string[]"},"awaitSpeech":{"type":"boolean","description":"Hold the function until the agent has finished speaking — any text said alongside the call, then the started message — instead of running it while the agent is still talking. Defaults to false.","nullable":false,"uniqueKey":"oneOf.0.lifecycleMessages.awaitSpeech","typeLabel":"boolean"}},"required":["started"],"description":"Messages to display during function execution lifecycle events.","uniqueKey":"oneOf.0.lifecycleMessages","typeLabel":"object"},"allowAnyNumber":{"type":"boolean","description":"Instead of using a fixed list of allowed numbers, allow the agent to transfer to any number (not recommended).","uniqueKey":"oneOf.0.allowAnyNumber","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"Transfer · object"},{"type":"object","title":"API","required":["apiPath","headers","inputJsonSchema"],"properties":{"apiPath":{"type":"string","description":"The path to the API.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.apiPath","typeLabel":"string"},"headers":{"type":"array","description":"Headers to be sent with the API request","items":{"type":"object","properties":{"key":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"oneOf.1.headers.items.[INDEX]","typeLabel":"object"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers","typeLabel":"object[]"},"inputJsonSchema":{"type":"string","description":"The JSON schema for the input to the function. Must be a top level object.","isRequired":true,"uniqueKey":"oneOf.1.inputJsonSchema","typeLabel":"string"},"name":{"type":"string","description":"The name of the function.","nullable":false,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"displayName":{"type":"string","description":"A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model. Set it to an empty string to fall back to the name.","nullable":false,"uniqueKey":"oneOf.1.displayName","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does.","nullable":false,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"type":{"type":"string","enum":["transfer","api"],"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"lifecycleMessages":{"type":"object","properties":{"started":{"type":"array","description":"Messages to display when the function starts executing. One will be chosen at random.","items":{"type":"string","uniqueKey":"oneOf.1.lifecycleMessages.started.items.[INDEX]","typeLabel":"string"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.lifecycleMessages.started","typeLabel":"string[]"},"waiting":{"type":"array","description":"Messages to play while the function is still running and the model returned StillWaiting. One will be chosen at random. If empty, a built-in default set of English phrases is used.","items":{"type":"string","uniqueKey":"oneOf.1.lifecycleMessages.waiting.items.[INDEX]","typeLabel":"string"},"nullable":false,"uniqueKey":"oneOf.1.lifecycleMessages.waiting","typeLabel":"string[]"},"awaitSpeech":{"type":"boolean","description":"Hold the function until the agent has finished speaking — any text said alongside the call, then the started message — instead of running it while the agent is still talking. Defaults to false.","nullable":false,"uniqueKey":"oneOf.1.lifecycleMessages.awaitSpeech","typeLabel":"boolean"}},"required":["started"],"description":"Messages to display during function execution lifecycle events.","uniqueKey":"oneOf.1.lifecycleMessages","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"API · object"}],"uniqueKey":"","typeLabel":"Transfer · object | API · object"},"examples":{"Example":{"title":"Example","value":{"allowedNumbers":[{"number":"\u003cstring>"}],"name":"\u003cstring>","displayName":"\u003cstring>","description":"\u003cstring>","allowAnyNumber":true}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"dbccdcb7-880a-4285-8d18-b06282269aed":{"description":"Successful operation","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Transfer","required":["allowedNumbers","allowAnyNumber","id","name","displayName","description","type"],"properties":{"id":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the function.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"displayName":{"type":"string","description":"A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model, and empty when unset — display the name in that case.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.displayName","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"type":{"type":"string","enum":["transfer","api"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"allowedNumbers":{"type":"array","description":"The numbers that the agent is allowed to transfer to.","items":{"type":"object","properties":{"number":{"type":"string","nullable":false,"description":"The number in e.164 format.","isRequired":true,"uniqueKey":"oneOf.0.allowedNumbers.items.[INDEX].number","typeLabel":"string"}},"required":["number"],"uniqueKey":"oneOf.0.allowedNumbers.items.[INDEX]","typeLabel":"object"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.allowedNumbers","typeLabel":"object[]"},"allowAnyNumber":{"type":"boolean","description":"Instead of using a fixed list of allowed numbers, allow the agent to transfer to any number (not recommended).","isRequired":true,"uniqueKey":"oneOf.0.allowAnyNumber","typeLabel":"boolean"},"lifecycleMessages":{"type":"object","properties":{"started":{"type":"array","description":"Messages to display when the function starts executing. One will be chosen at random.","items":{"type":"string","uniqueKey":"oneOf.0.lifecycleMessages.started.items.[INDEX]","typeLabel":"string"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.lifecycleMessages.started","typeLabel":"string[]"},"waiting":{"type":"array","description":"Messages to play while the function is still running and the model returned StillWaiting. One will be chosen at random. If empty, a built-in default set of English phrases is used.","items":{"type":"string","uniqueKey":"oneOf.0.lifecycleMessages.waiting.items.[INDEX]","typeLabel":"string"},"nullable":false,"uniqueKey":"oneOf.0.lifecycleMessages.waiting","typeLabel":"string[]"},"awaitSpeech":{"type":"boolean","description":"Hold the function until the agent has finished speaking — any text said alongside the call, then the started message — instead of running it while the agent is still talking. Defaults to false.","nullable":false,"uniqueKey":"oneOf.0.lifecycleMessages.awaitSpeech","typeLabel":"boolean"}},"required":["started"],"description":"Messages to display during function execution lifecycle events.","uniqueKey":"oneOf.0.lifecycleMessages","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Transfer · object"},{"type":"object","title":"API","required":["apiPath","headers","inputJsonSchema","id","name","displayName","description","type"],"properties":{"id":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the function.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"displayName":{"type":"string","description":"A human readable label for the function, used in the Vogent dashboard instead of the name. Never shown to the model, and empty when unset — display the name in that case.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.displayName","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"type":{"type":"string","enum":["transfer","api"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"apiPath":{"type":"string","description":"The path to the API.","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.apiPath","typeLabel":"string"},"headers":{"type":"array","description":"Headers to be sent with the API request","items":{"type":"object","properties":{"key":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"oneOf.1.headers.items.[INDEX]","typeLabel":"object"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.headers","typeLabel":"object[]"},"inputJsonSchema":{"type":"string","description":"The JSON schema for the input to the function. Must be a top level object.","isRequired":true,"uniqueKey":"oneOf.1.inputJsonSchema","typeLabel":"string"},"lifecycleMessages":{"type":"object","properties":{"started":{"type":"array","description":"Messages to display when the function starts executing. One will be chosen at random.","items":{"type":"string","uniqueKey":"oneOf.1.lifecycleMessages.started.items.[INDEX]","typeLabel":"string"},"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.lifecycleMessages.started","typeLabel":"string[]"},"waiting":{"type":"array","description":"Messages to play while the function is still running and the model returned StillWaiting. One will be chosen at random. If empty, a built-in default set of English phrases is used.","items":{"type":"string","uniqueKey":"oneOf.1.lifecycleMessages.waiting.items.[INDEX]","typeLabel":"string"},"nullable":false,"uniqueKey":"oneOf.1.lifecycleMessages.waiting","typeLabel":"string[]"},"awaitSpeech":{"type":"boolean","description":"Hold the function until the agent has finished speaking — any text said alongside the call, then the started message — instead of running it while the agent is still talking. Defaults to false.","nullable":false,"uniqueKey":"oneOf.1.lifecycleMessages.awaitSpeech","typeLabel":"boolean"}},"required":["started"],"description":"Messages to display during function execution lifecycle events.","uniqueKey":"oneOf.1.lifecycleMessages","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"API · object"}],"uniqueKey":"","typeLabel":"Transfer · object | API · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","displayName":"\u003cstring>","description":"\u003cstring>","type":"transfer","allowedNumbers":[{"number":"\u003cstring>"}],"allowAnyNumber":true,"lifecycleMessages":{"started":["\u003cstring>"],"waiting":["\u003cstring>"],"awaitSpeech":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"1aadc50b-0338-484c-88c9-1988e56ee396":{"description":"Invalid input","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7015ff81-b88c-4583-8651-0c259f6552f5":{"description":"Validation exception","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"02d4cac2-c08d-4613-ad1d-fdfdb10be0db":{"bearerAuth":{"type":"http","scheme":"bearer","description":"In the form `Bearer \u003capi_key_here>`. You can find your api key in your dashboard.","scopes":[]}}},"servers":{"b09f045b-12f8-4298-8576-2f7cd9d22cec":{"url":"https://api.vogent.ai/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"In the form `Bearer \u003capi_key_here>`. You can find your api key in your dashboard.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"In the form `Bearer \u003capi_key_here>`. You can find your api key in your dashboard.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"elto-1","siteName":"Vogent","title":"Update function - Vogent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-12T20:56:59.994Z","originalFileLocation":"api-reference/update-function.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 a specific function.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vogent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_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/elto-1/gR61agxbBlUmNgt_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update function - Vogent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a specific function.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vogent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vogent.ai/api-reference/update-function\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://elto-1.mintlify.app/_mintlify/api/og/v2?division=Functions\u0026amp;title=Update+function\u0026amp;description=Updates+a+specific+function.\u0026amp;theme=6bdcd5822d317c01d3b7f839\u0026amp;signature=d1ed556505370c1dccb92e27593c0d58e6a922c262be05ddf58b0b27807bd86e\">\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 function - Vogent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a specific function.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://elto-1.mintlify.app/_mintlify/api/og/v2?division=Functions\u0026amp;title=Update+function\u0026amp;description=Updates+a+specific+function.\u0026amp;theme=6bdcd5822d317c01d3b7f839\u0026amp;signature=d1ed556505370c1dccb92e27593c0d58e6a922c262be05ddf58b0b27807bd86e\">\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/elto-1/gR61agxbBlUmNgt_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vogent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E4CFE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vogent.ai/api-reference/update-function\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/update-function.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vogent.ai/#organization\",\"name\":\"Vogent\",\"url\":\"https://docs.vogent.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/elto-1/ooEImm5m-H0BmxUg/logo/light.svg?fit=max\u0026auto=format\u0026n=ooEImm5m-H0BmxUg\u0026q=85\u0026s=4bdeb0d3b2f061ef727c095d1cbccfeb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vogent.ai#website\",\"name\":\"Vogent\",\"url\":\"https://docs.vogent.ai\",\"publisher\":{\"@id\":\"https://docs.vogent.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vogent.ai/api-reference/update-function#webpage\",\"url\":\"https://docs.vogent.ai/api-reference/update-function\",\"name\":\"Update function\",\"description\":\"Updates a specific function.\",\"dateModified\":\"2025-08-12T20:56:59.994Z\",\"isPartOf\":{\"@id\":\"https://docs.vogent.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vogent.ai/api-reference/update-function#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vogent.ai/api-reference/update-function#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Functions\",\"item\":\"https://docs.vogent.ai/api-reference/create-a-function\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update function\",\"item\":\"https://docs.vogent.ai/api-reference/update-function\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vogent.ai/api-reference/update-function#apireference\",\"headline\":\"Update function\",\"name\":\"Update function\",\"description\":\"Updates a specific function.\",\"url\":\"https://docs.vogent.ai/api-reference/update-function\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vogent.ai/api-reference/update-function#webpage\"},\"dateModified\":\"2025-08-12T20:56:59.994Z\",\"publisher\":{\"@id\":\"https://docs.vogent.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vogent.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vogent\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vogent","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Dials","pages":[{"openapi":"post /dials","title":"Create a new dial","href":"/api-reference/create-a-new-dial"},{"openapi":"post /dials/{id}/hangup","title":"Hangup Dial.","href":"/api-reference/hangup-dial"},{"openapi":"get /dials/{id}","title":"Get Dial","href":"/api-reference/get-dial"},{"openapi":"post /dials/{id}/token","title":"Get Dial Token","href":"/api-reference/get-dial-token"}]},{"group":"Agents","pages":[{"openapi":"get /agents","title":"List Agents","href":"/api-reference/list-agents"},{"openapi":"post /agents","title":"Create Agent","href":"/api-reference/create-agent"},{"openapi":"put /agents/{id}","title":"Update Agent","href":"/api-reference/update-agent"},{"openapi":"delete /agents/{id}","title":"Delete Agent","href":"/api-reference/delete-agent"}]},{"group":"Voices","pages":[{"openapi":"post /voices/clone","title":"Clone Voice","href":"/api-reference/clone-voice"},{"openapi":"get /voices","title":"List Voices","href":"/api-reference/list-voices"}]},{"group":"Versioned Prompts","pages":[{"openapi":"get /agents/{agentId}/versioned_prompts","title":"List versioned prompts","href":"/api-reference/list-versioned-prompts"},{"openapi":"get /agents/{agentId}/versioned_prompts/{id}","title":"Get versioned prompt","href":"/api-reference/get-versioned-prompt"},{"openapi":"put /agents/{agentId}/versioned_prompts/{id}","title":"Update versioned prompt","href":"/api-reference/update-versioned-prompt"},{"openapi":"post /agents/{agentId}/versioned_prompts","title":"Create versioned prompt","href":"/api-reference/create-versioned-prompt"}]},{"group":"Extractors","pages":[{"openapi":"get /agents/{agentId}/extractors/{extractorId}","title":"Get extractor","href":"/api-reference/get-extractor"},{"openapi":"get /agents/{agentId}/extractors","title":"List extractors","href":"/api-reference/list-extractors"},{"openapi":"post /agents/{agentId}/extractors","title":"Create extractor","href":"/api-reference/create-extractor"},{"openapi":"put /agents/{agentId}/extractors/{extractorId}","title":"Update extractor","href":"/api-reference/update-extractor"}]},{"group":"Phone Numbers","pages":[{"openapi":"get /phone_numbers","title":"List phone numbers","href":"/api-reference/list-phone-numbers"},{"openapi":"get /phone_numbers/{id}","title":"Get Phone Number","href":"/api-reference/get-phone-number"},{"openapi":"put /phone_numbers/{id}","title":"Update Phone Number","href":"/api-reference/update-phone-number"},{"openapi":"post /phone_numbers","title":"Create a phone number","href":"/api-reference/create-number"},{"openapi":"post /phone_numbers/search","title":"Search for available numbers","href":"/api-reference/search-for-available-numbers"},{"openapi":"post /phone_numbers/purchase","title":"Purchase available number (deprecated, use /phone_numbers instead)","href":"/api-reference/purchase-available-number"},{"openapi":"delete /phone_numbers/{id}","title":"Delete Phone Number","href":"/api-reference/delete-phone-number"}]},{"group":"Functions","pages":[{"openapi":"post /functions","title":"Create a function","href":"/api-reference/create-a-function"},{"openapi":"get /functions/{id}","title":"Get function","description":"Gets a specific function.","href":"/api-reference/get-function"},{"openapi":"put /functions/{id}","title":"Update function","href":"/api-reference/update-function"},{"openapi":"delete /functions/{id}","title":"Delete function","description":"Deletes a function, and unlinks it from any agents.","href":"/api-reference/delete-function"}]},{"group":"Models","pages":[{"openapi":"get /models","title":"List Models","href":"/api-reference/list-models"}]},{"group":"Voicelab","pages":[{"openapi":"post /tts","title":"Run TTS Model","href":"/api-reference/run-tts-model"},{"openapi":"post /tts/multispeaker","title":"Run Multispeaker TTS Model","href":"/api-reference/run-multispeaker-tts-model"},{"title":"Websocket TTS","asyncapi":"api-reference/asyncapi.yaml channelOne","href":"/api-reference/voicelab-websocket-tts"}]},{"group":"Batch Dials","pages":[{"openapi":"get /batch_dial_jobs","title":"List Batch Jobs","href":"/api-reference/list-batch-dial-jobs"},{"openapi":"post /batch_dial_jobs","title":"Create Batch Job","href":"/api-reference/create-a-new-batch-dial-job"},{"openapi":"get /batch_dial_jobs/{id}","title":"Get Batch Job","href":"/api-reference/get-batch-dial-job"},{"openapi":"put /batch_dial_jobs/{id}","title":"Update Batch Job","href":"/api-reference/update-batch-dial-job"},{"openapi":"get /batch_dial_jobs/{id}/queue","title":"List Queued Batch Dials","href":"/api-reference/list-queued-dials-for-batch-dial-job"},{"openapi":"post /batch_dial_jobs/{id}/paused","title":"Pause/Resume Batch Job","href":"/api-reference/set-batch-dial-job-paused"},{"openapi":"get /batch_dial_jobs/{id}/dials","title":"List Batch Dials","href":"/api-reference/list-batch-dials"}]},{"group":"Eval Configs","pages":[{"openapi":"get /eval_configs","title":"List Eval Configs","href":"/api-reference/list-eval-configs"},{"openapi":"post /eval_configs","title":"Create Eval Config","href":"/api-reference/create-eval-config"},{"openapi":"get /eval_configs/{id}","title":"Get Eval Config","href":"/api-reference/get-eval-config"},{"openapi":"put /eval_configs/{id}","title":"Update Eval Config","href":"/api-reference/update-eval-config"}]},{"group":"Eval Records","pages":[{"openapi":"get /eval_configs/{id}/records","title":"List Eval Config Records","href":"/api-reference/list-eval-config-records"},{"openapi":"post /eval_configs/{id}/records","title":"Create Eval Config Record","href":"/api-reference/create-eval-config-record"},{"openapi":"get /eval_configs/{id}/records/{recordId}","title":"Get Eval Record","href":"/api-reference/get-eval-record"},{"openapi":"put /eval_configs/{id}/records/{recordId}","title":"Update Eval Record","href":"/api-reference/update-eval-record"},{"openapi":"delete /eval_configs/{id}/records/{recordId}","title":"Delete Eval Record","href":"/api-reference/delete-eval-record"}]},{"group":"Eval Runs","pages":[{"openapi":"get /eval_configs/{id}/runs","title":"List Eval Config Runs","href":"/api-reference/list-eval-config-runs"},{"openapi":"post /eval_configs/{id}/runs","title":"Run Eval","href":"/api-reference/run-eval"},{"openapi":"get /eval_runs/{id}","title":"Get Eval Run","href":"/api-reference/get-eval-run"},{"openapi":"get /eval_runs/{id}/results","title":"List Eval Run Results","href":"/api-reference/list-eval-run-results"},{"openapi":"get /eval_results/{id}","title":"Get Eval Result","href":"/api-reference/get-eval-result"},{"openapi":"post /eval_runs/{id}/cancel","title":"Cancel Eval Run","href":"/api-reference/cancel-eval-run"},{"openapi":"post /eval_results/{id}/rerun","title":"Rerun Eval Result","href":"/api-reference/rerun-eval-result"}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/web-sdk"}]},{"tab":"Voicelab","pages":[{"title":"Voicelab","href":"/voicelab/introduction"}]}]},"basePath":"","title":"Update function - Vogent","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}