Whether the agent was successfully updated, can be either success or failed
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Cald AI","colors":{"primary":"#6128c9","light":"#7e66e8","dark":"#100930"},"favicon":"/favicon.jpg","logo":{"light":"https://mintcdn.com/caldai/ds03Lyn4vd_-LMFj/logo/light.svg?fit=max\u0026auto=format\u0026n=ds03Lyn4vd_-LMFj\u0026q=85\u0026s=701689eb8443c639d62306cdffdc4e32","dark":"https://mintcdn.com/caldai/ds03Lyn4vd_-LMFj/logo/dark.svg?fit=max\u0026auto=format\u0026n=ds03Lyn4vd_-LMFj\u0026q=85\u0026s=ef549e63a82e9ec6e72b462244c51741"},"api":{"openapi":["api-reference/openapi.json"]},"navbar":{"links":[{"label":"Support","href":"mailto:support@cald.ai"}],"primary":{"type":"button","label":"MyCald Dashboard","href":"https://my.cald.ai"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cald-ai"}},"navigation":{"global":{"anchors":[{"anchor":"Website","href":"https://cald.ai","icon":"globe"},{"anchor":"Community","href":"https://discord.gg/2sTGFBCsKk","icon":"discord"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"caldai","hasAudioNarration":false,"actualSubdomain":"caldai","customDomains":["docs.cald.ai"],"gitSource":{"type":"github","owner":"francoisvogel","repo":"cald-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c40b41886f9eab77bfc8","collectionId":"951a1bc8-e84e-46f4-bfb1-3ab8763a20b7","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c40b41886f9eab77bfc8:success","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Agents","count":6},{"language":"default","tag":"Campaigns","count":5},{"language":"default","tag":"Lists of Contacts","count":5},{"language":"default","tag":"Phone Number Management (U.S. Only)","count":4},{"language":"default","tag":"Voices","count":3},{"language":"default","tag":"Contacts","count":2},{"language":"default","tag":"Call (Deprecated)","count":1},{"language":"default","tag":"Calls","count":1},{"language":"default","tag":"Documentation","count":1}]},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/update-agent","slug":"/api-reference/endpoint/update-agent","pageMetadata":{"title":"Edit an Agent","openapi":"PATCH /agents/{agentId}","description":"Update the details of a specific agent","href":"/api-reference/endpoint/update-agent"},"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: \"Update the details of a specific agent\"\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":"Edit an Agent","openapi":"PATCH /agents/{agentId}","description":"Update the details of a specific agent","href":"/api-reference/endpoint/update-agent"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Update the details of a specific agent","parameters":["74963d28-7c83-40cc-80f8-0a80e3c000ab"],"requestBody":"c29db9a6-ad55-4cf1-8e2c-06b7451351ff","responses":{"200":"8ca8bc50-a372-4b6d-9410-abcea9bda856","404":"202f9ac5-4b58-4253-82d4-be7f3a6429e9"},"method":"patch","type":"path","servers":["9fc98c87-b07a-4190-a2df-a279790a238b"],"security":["38d8811e-1a7f-42b3-9fc5-d94acb7efb98"],"path":"/agents/{agentId}","baseUrlOptions":["https://my.cald.ai/client/api/v1"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"74963d28-7c83-40cc-80f8-0a80e3c000ab":{"name":"agentId","in":"path","description":"The agent ID of the agent","required":true,"schema":{"type":"string","description":"The agent ID of the agent","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name given to the agent in the MyCald Dashboard","uniqueKey":"name","typeLabel":"string"},"maxCallDuration":{"type":"number","description":"The maximum duration of a call in minutes, between 1 and 60","default":10,"uniqueKey":"maxCallDuration","typeLabel":"number"},"recordingSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable recording of the calls","default":false,"uniqueKey":"recordingSettings.enable","typeLabel":"boolean"}},"uniqueKey":"recordingSettings","typeLabel":"object"},"instructions":{"type":"string","description":"The instructions for the agent, for example, `Hi, convince the prospect to buy the product`","uniqueKey":"instructions","typeLabel":"string"},"greeting":{"type":"string","description":"The greeting for the agent, for example, `Hi there!`","uniqueKey":"greeting","typeLabel":"string"},"transferSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable transfer of the calls","default":false,"uniqueKey":"transferSettings.enable","typeLabel":"boolean"},"rule":{"type":"string","description":"The rule to use for transferring the calls, for example: `transfer the call if the prospect would like to have more information or the AI is unable to answer the question`","default":"always","uniqueKey":"transferSettings.rule","typeLabel":"string"},"phoneNumber":{"type":"string","description":"The phone number to transfer the call to","uniqueKey":"transferSettings.phoneNumber","typeLabel":"string"}},"uniqueKey":"transferSettings","typeLabel":"object"},"machineSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable machine detection (e.g. IVR, voicemail), where the AI will hang up if it detects a machine","default":false,"uniqueKey":"machineSettings.enable","typeLabel":"boolean"}},"uniqueKey":"machineSettings","typeLabel":"object"},"voicemailSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable saying a voicemail message if the call is picked up by a voicemail","default":false,"uniqueKey":"voicemailSettings.enable","typeLabel":"boolean"},"voicemail":{"type":"string","description":"The message to say, only available if `enable` is set to `true`, for example, `Hi, this is the AI assistant calling on behalf of John Smith. I was curious if you would be interested in our product. Please call us back at 123-456-7890.`","uniqueKey":"voicemailSettings.voicemail","typeLabel":"string"}},"uniqueKey":"voicemailSettings","typeLabel":"object"},"webhookSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable sending of a webhook to a URL of your choice when the call is completed","default":false,"uniqueKey":"webhookSettings.enable","typeLabel":"boolean"},"url":{"type":"string","description":"The webhook needs to be an HTTP or HTTPS callback URL. Upon completion of the call, we'll transmit the call ID, transcript, etc. to this URL. This feature is beneficial for receiving real-time notifications at the conclusion of calls.","uniqueKey":"webhookSettings.url","typeLabel":"string"}},"uniqueKey":"webhookSettings","typeLabel":"object"},"smsSettings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable sending of text messages","default":false,"uniqueKey":"smsSettings.enable","typeLabel":"boolean"},"rule":{"type":"string","description":"The rule to use for sending text messages, for example: `send a text message if the prospect is interested in the offer`","default":"always","uniqueKey":"smsSettings.rule","typeLabel":"string"},"message":{"type":"string","description":"The message to send, only available if `enable` is set to `true`, for example, `Hi, please visit our website at https://www.example.com` for more information.`","uniqueKey":"smsSettings.message","typeLabel":"string"}},"uniqueKey":"smsSettings","typeLabel":"object"},"voice":{"type":"string","description":"The voice ID of the voice to use for the agent, for example, `standard_male`","default":"standard_male","uniqueKey":"voice","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","maxCallDuration":10,"recordingSettings":{"enable":false},"instructions":"\u003cstring>","greeting":"\u003cstring>","transferSettings":{"enable":false,"rule":"always","phoneNumber":"\u003cstring>"},"machineSettings":{"enable":false},"voicemailSettings":{"enable":false,"voicemail":"\u003cstring>"},"webhookSettings":{"enable":false,"url":"\u003cstring>"},"smsSettings":{"enable":false,"rule":"always","message":"\u003cstring>"},"voice":"standard_male"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8ca8bc50-a372-4b6d-9410-abcea9bda856":{"description":"Success response with agent details","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Whether the agent was successfully updated, can be either `success` or `failed`","uniqueKey":"status","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"202f9ac5-4b58-4253-82d4-be7f3a6429e9":{"description":"Agent not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"38d8811e-1a7f-42b3-9fc5-d94acb7efb98":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Your API key, e.g. `caldLiveDe39a3accb206dd615f30d118e519df0`","scopes":[]}}},"servers":{"9fc98c87-b07a-4190-a2df-a279790a238b":{"url":"https://my.cald.ai/client/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Your API key, e.g. `caldLiveDe39a3accb206dd615f30d118e519df0`","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Your API key, e.g. `caldLiveDe39a3accb206dd615f30d118e519df0`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"caldai","siteName":"Cald AI","title":"Edit an Agent - Cald AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:53:31.068Z","originalFileLocation":"api-reference/endpoint/update-agent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update the details of a specific agent\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cald AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_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/caldai/gFpYQ8btuVLkRItW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Edit an Agent - Cald AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the details of a specific agent\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cald AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cald.ai/api-reference/endpoint/update-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://caldai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Edit+an+Agent\u0026amp;description=Update+the+details+of+a+specific+agent\u0026amp;theme=2a88449871d4cd4e048f0efa\u0026amp;signature=7c809f719595a272704832f4beb5cb298291b56c3e6f9bc184257bdd6c8ad15a\">\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=\"Edit an Agent - Cald AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the details of a specific agent\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://caldai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Edit+an+Agent\u0026amp;description=Update+the+details+of+a+specific+agent\u0026amp;theme=2a88449871d4cd4e048f0efa\u0026amp;signature=7c809f719595a272704832f4beb5cb298291b56c3e6f9bc184257bdd6c8ad15a\">\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/caldai/gFpYQ8btuVLkRItW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cald AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6128c9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cald.ai/api-reference/endpoint/update-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/update-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cald.ai/#organization\",\"name\":\"Cald AI\",\"url\":\"https://docs.cald.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/caldai/ds03Lyn4vd_-LMFj/logo/light.svg?fit=max\u0026auto=format\u0026n=ds03Lyn4vd_-LMFj\u0026q=85\u0026s=701689eb8443c639d62306cdffdc4e32\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cald.ai#website\",\"name\":\"Cald AI\",\"url\":\"https://docs.cald.ai\",\"publisher\":{\"@id\":\"https://docs.cald.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cald.ai/api-reference/endpoint/update-agent#webpage\",\"url\":\"https://docs.cald.ai/api-reference/endpoint/update-agent\",\"name\":\"Edit an Agent\",\"description\":\"Update the details of a specific agent\",\"dateModified\":\"2026-01-06T23:53:31.068Z\",\"isPartOf\":{\"@id\":\"https://docs.cald.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cald.ai/api-reference/endpoint/update-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cald.ai/api-reference/endpoint/update-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.cald.ai/api-reference/endpoint/agents-add\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Edit an Agent\",\"item\":\"https://docs.cald.ai/api-reference/endpoint/update-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cald.ai/api-reference/endpoint/update-agent#apireference\",\"headline\":\"Edit an Agent\",\"name\":\"Edit an Agent\",\"description\":\"Update the details of a specific agent\",\"url\":\"https://docs.cald.ai/api-reference/endpoint/update-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cald.ai/api-reference/endpoint/update-agent#webpage\"},\"dateModified\":\"2026-01-06T23:53:31.068Z\",\"publisher\":{\"@id\":\"https://docs.cald.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cald.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cald AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cald AI","nav":{"global":{"anchors":[{"anchor":"Website","href":"https://cald.ai","icon":"globe"},{"anchor":"Community","href":"https://discord.gg/2sTGFBCsKk","icon":"discord"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Agents","pages":[{"title":"Create an Agent","openapi":"POST /agents","href":"/api-reference/endpoint/agents-add"},{"title":"Get Agents","openapi":"GET /agents","href":"/api-reference/endpoint/get-agents"},{"title":"Get an Agent","openapi":"GET /agents/{agentId}","description":"Get information about a specific agent","href":"/api-reference/endpoint/get-agent"},{"title":"Edit an Agent","openapi":"PATCH /agents/{agentId}","href":"/api-reference/endpoint/update-agent"},{"title":"Delete an Agent","openapi":"DELETE /agents/{agentId}","description":"Delete a specific agent","href":"/api-reference/endpoint/delete-agent"},{"title":"Make a Call Using an Agent","openapi":"POST /agents/{agentId}/call","href":"/api-reference/endpoint/agents-call"}]},{"group":"Voices","pages":[{"title":"List Voices","openapi":"GET /voices","href":"/api-reference/endpoint/get-voices"},{"title":"Clone a Voice","openapi":"POST /voices/clone","href":"/api-reference/endpoint/clone-voice"},{"title":"Delete a Voice","openapi":"DELETE /voices/{voice}","href":"/api-reference/endpoint/delete-voice"}]},{"group":"Calls","pages":[{"title":"Get Call Logs","openapi":"GET /calls/{callId}","href":"/api-reference/endpoint/get-call"}]},{"group":"Phone Number Management (U.S. Only)","pages":[{"title":"Buy a Phone Number","openapi":"POST /phonenumbers","href":"/api-reference/endpoint/buy-phone-number"},{"title":"Get a list of all phone numbers that you own","openapi":"GET /phonenumbers","href":"/api-reference/endpoint/get-phone-numbers"},{"title":"Edit Phone Number Settings","openapi":"PATCH /phonenumbers/{phoneNumberId}","href":"/api-reference/endpoint/edit-phone-number"},{"title":"Cancel a Phone Number Subscription","openapi":"DELETE /phonenumbers/{phoneNumberId}","href":"/api-reference/endpoint/delete-phone-number"}]},{"group":"Lists of Contacts","pages":[{"title":"Create a List","openapi":"POST /lists","href":"/api-reference/endpoint/lists-add"},{"title":"Get Lists","openapi":"GET /lists","href":"/api-reference/endpoint/get-lists"},{"title":"Get a List","openapi":"GET /lists/{listId}","href":"/api-reference/endpoint/get-list"},{"title":"Edit a List","openapi":"PATCH /lists/{listId}","href":"/api-reference/endpoint/edit-list"},{"title":"Delete a List","openapi":"DELETE /lists/{listId}","href":"/api-reference/endpoint/delete-list"}]},{"group":"Contacts","pages":[{"title":"Upload Contacts to a List","openapi":"POST /lists/{listId}/contacts","href":"/api-reference/endpoint/contacts-add"},{"title":"Get Contacts in a List","openapi":"GET /lists/{listId}/contacts","href":"/api-reference/endpoint/get-contacts"}]},{"group":"Campaigns","pages":[{"title":"Create a Campaign","openapi":"POST /campaigns","href":"/api-reference/endpoint/campaigns-add"},{"title":"Get Campaigns","openapi":"GET /campaigns","href":"/api-reference/endpoint/get-campaigns"},{"title":"Get a Campaign","openapi":"GET /campaigns/{campaignId}","href":"/api-reference/endpoint/get-campaign"},{"title":"Get Campaign Results","openapi":"GET /campaigns/{campaignId}/details","href":"/api-reference/endpoint/get-campaign-details"},{"title":"Cancel a Campaign","openapi":"PUT /campaigns/{campaignId}/cancel","href":"/api-reference/endpoint/cancel-campaign"}]},{"group":"Call (Deprecated)","pages":[{"title":"Make a Call (Deprecated)","openapi":"POST /call","href":"/api-reference/endpoint/call"}]}]}]},"title":"Edit an Agent - Cald AI","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}