Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent’s
settings. Applies from the next call. The web app shows the change and its author at once.
The ETag from your last read: the change is made only if the resource still has it, otherwise 412. Optional, except that a change replacing a list needs it (428 without it).
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Phonely Documentation","colors":{"primary":"#6B0099","light":"#9B30FF","dark":"#4A0069"},"logo":{"light":"https://mintcdn.com/phonely/iCxxv_3GatFhm6IZ/logo/logo-purple.png?fit=max\u0026auto=format\u0026n=iCxxv_3GatFhm6IZ\u0026q=85\u0026s=2afc59be170ec958ea83d390334811aa","dark":"https://mintcdn.com/phonely/dH0twDC21AoP59KD/logo/logo-white.png?fit=max\u0026auto=format\u0026n=dH0twDC21AoP59KD\u0026q=85\u0026s=b5d27a050b6e30e42a6b316d3e97d3b7"},"favicon":{"light":"https://mintcdn.com/phonely/iCxxv_3GatFhm6IZ/logo/logo-small-purple.svg?fit=max\u0026auto=format\u0026n=iCxxv_3GatFhm6IZ\u0026q=85\u0026s=90c51a46396e34e88639806993bac698","dark":"https://mintcdn.com/phonely/iCxxv_3GatFhm6IZ/logo/logo-small-white.svg?fit=max\u0026auto=format\u0026n=iCxxv_3GatFhm6IZ\u0026q=85\u0026s=34a68aa8fbb2312361db928be195131d"},"api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"},{"href":"https://discord.gg/BMHPUaZG37","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.phonely.ai"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/phonely-ai","discord":"https://discord.gg/BMHPUaZG37"}},"seo":{"indexing":"navigable"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","add-mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://app.phonely.ai"},{"anchor":"Community","icon":"users","href":"https://discord.gg/BMHPUaZG37"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phonely","hasAudioNarration":false,"actualSubdomain":"phonely","customDomains":["docs.phonely.ai"],"gitSource":{"type":"github","owner":"phonely-ai","repo":"frontend-api-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3c0d15509c500e6d81540","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Home","count":74},{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"BUILD YOUR AGENT","count":43},{"language":"default","tag":"API v1 endpoints","count":34},{"language":"default","tag":"Legacy API","count":23},{"language":"default","tag":"Block Reference","count":20},{"language":"default","tag":"Agents","count":20},{"language":"default","tag":"Flow Editor","count":10},{"language":"default","tag":"Integrations","count":9},{"language":"default","tag":"API v1","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"css/custom.css","content":"a.text-sm.text-gray-500.dark\\:text-gray-400.hover\\:text-gray-700.dark\\:hover\\:text-gray-300.text-nowrap{display:none!important}::-webkit-scrollbar{width:4px;height:4px;background:transparent}::-webkit-scrollbar-track{background:transparent}::-webkit-scrollbar-thumb{background:rgba(0, 0, 0, 0.2);border-radius:2px}::-webkit-scrollbar-thumb:hover{background:rgba(0, 0, 0, 0.3)}*{scrollbar-width:thin;scrollbar-color:rgba(0, 0, 0, 0.2) transparent}html,body{-ms-overflow-style:none}main,.content,[role=\"main\"],.main-content,.mintlify-doc-content,.mintlify-doc-content>div,[data-mintlify-doc-content],article,.article-content{overscroll-behavior:contain}aside,.sidebar,[role=\"complementary\"],[class*=\"sidebar\"],[class*=\"toc\"],[class*=\"table-of-contents\"],[class*=\"on-this-page\"],[class*=\"right-sidebar\"],[class*=\"right-side\"],[data-mintlify-toc],.mintlify-toc{overscroll-behavior:contain}nav,[role=\"navigation\"],[class*=\"nav\"],[class*=\"menu\"]{overscroll-behavior:contain}[class*=\"Card\"] a,a[class*=\"card\"]{transition:transform 0.15s ease, box-shadow 0.15s ease}[class*=\"Card\"] a:hover,a[class*=\"card\"]:hover{transform:translateY(-2px);box-shadow:0 4px 12px rgba(0, 0, 0, 0.08)}.dark [class*=\"Card\"] a:hover,.dark a[class*=\"card\"]:hover{box-shadow:0 4px 12px rgba(0, 0, 0, 0.24)}article h2{margin-top:2.5rem}article h3{margin-top:1.75rem}:root{--iframe-border-radius: 8px;--iframe-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);--iframe-margin: 1rem 0;--iframe-transition: padding-bottom 0.3s ease, max-height 0.3s ease;--iframe-aspect-large: 50%;--iframe-aspect-desktop: 56.25%;--iframe-aspect-tablet-landscape: 52.5%;--iframe-aspect-tablet-portrait: 60%;--iframe-aspect-mobile: 66.67%;--iframe-aspect-very-small: 75%;--iframe-max-height-large: 600px;--iframe-max-height-desktop: 500px;--iframe-max-height-tablet-landscape: 400px;--iframe-max-height-tablet-portrait: 350px;--iframe-max-height-mobile: 300px;--iframe-max-height-very-small: 250px}.responsive-iframe-container{position:relative;width:100%;height:0;overflow:hidden;border-radius:var(--iframe-border-radius);box-shadow:var(--iframe-shadow);margin:var(--iframe-margin);transition:var(--iframe-transition)}.responsive-iframe-container iframe{position:absolute;top:0;left:0;width:100%;height:100%;border:none;border-radius:var(--iframe-border-radius)}.responsive-iframe,iframe.responsive-iframe{width:100%!important;aspect-ratio:16 / 9!important;border:none!important;border-radius:var(--iframe-border-radius)!important;box-shadow:var(--iframe-shadow)!important;margin:var(--iframe-margin)!important}.responsive-iframe-container{padding-bottom:var(--iframe-aspect-desktop)}@media (min-width: 1200px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-large);max-height:var(--iframe-max-height-large)}}@media (min-width: 992px) and (max-width: 1199px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-desktop);max-height:var(--iframe-max-height-desktop)}}@media (min-width: 768px) and (max-width: 991px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-tablet-landscape);max-height:var(--iframe-max-height-tablet-landscape)}}@media (min-width: 481px) and (max-width: 767px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-tablet-portrait);max-height:var(--iframe-max-height-tablet-portrait)}}@media (max-width: 480px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-mobile);max-height:var(--iframe-max-height-mobile)}}@media (max-width: 320px){.responsive-iframe-container{padding-bottom:var(--iframe-aspect-very-small);max-height:var(--iframe-max-height-very-small)}}.mintlify-doc-content .responsive-iframe-container,.mintlify-doc-content .responsive-iframe,.mintlify-doc-content iframe.responsive-iframe,[data-mintlify-doc-content] .responsive-iframe-container,[data-mintlify-doc-content] .responsive-iframe,[data-mintlify-doc-content] iframe.responsive-iframe{width:100%!important}"},{"filePath":"css/variables-table-alignment.css","content":""}],"page":{"pagePath":"api-reference/v1/agents/update-settings","slug":"/api-reference/v1/agents/update-settings","pageMetadata":{"title":"Update settings","description":"Change an agent's settings.\n\nOnly the fields sent change, and `null` resets a field to the default calls use. Answers with all of the agent's\nsettings. Applies from the next call. The web app shows the change and its author at once.","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/settings","href":"/api-reference/v1/agents/update-settings","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Change an agent’s settings.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Only the fields sent change, and \", _jsx(_components.code, {\n children: \"null\"\n }), \" resets a field to the default calls use. Answers with all of the agent’s\\nsettings. Applies from the next call. The web app shows the change and its author at once.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update settings","description":"Change an agent's settings.\n\nOnly the fields sent change, and `null` resets a field to the default calls use. Answers with all of the agent's\nsettings. Applies from the next call. The web app shows the change and its author at once.","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/settings","href":"/api-reference/v1/agents/update-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Change an agent's settings.\n\nOnly the fields sent change, and `null` resets a field to the default calls use. Answers with all of the agent's\nsettings. Applies from the next call. The web app shows the change and its author at once.","operationId":"update_agent_settings","parameters":["bdcea3c5-6a48-4a51-8959-7792eaf8589c","db652d24-b1cc-49be-8eb5-f9af820c478e","6e7612d6-d1eb-4e6d-8e89-39111cfde9c1"],"requestBody":"47063e47-9e94-4205-b54b-115034a855ce","responses":{"200":"fdaa5e63-ef9f-4b58-8046-40fa4a8039bf","400":"7425f789-1ec3-4008-b090-ae4d5390965a","401":"f757b4dd-a442-4571-b10e-f58c489e5c63","403":"b29e5865-23ac-4e09-a9de-16017aa877bd","404":"96e1ebee-5cd6-4bb6-b682-a8a193be1284","409":"167fb8cb-6dc9-4ea0-8fac-b6b4adadb528","412":"1e05e12e-6907-432a-aae8-224e05094f1b","429":"573d8dca-af0d-4e14-a9bb-707aba3d38e8","500":"9315a4d8-5dcd-48e3-850a-7225f805c511","503":"7d6e6ba0-0ba3-464a-b200-eb0000a07cc6"},"security":["b08c5778-d084-48c9-94db-95852b1eae5b"],"summary":"Update settings","tags":["Agents"],"x-permission":"write_configuration","x-scope":"organization","x-stability-level":"beta","x-mint":{"metadata":{"tag":"Beta"}},"method":"patch","type":"path","servers":["45f5f669-0210-42d7-9200-2ec9aaf7bbdf","fe17dd0b-2fbd-41c4-a2c3-cea1c909cb87"],"path":"/v1/agents/{id}/settings","baseUrlOptions":["https://api.us.phonely.ai","https://api.au.phonely.ai"],"title":"Update settings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bdcea3c5-6a48-4a51-8959-7792eaf8589c":{"description":"The agent's ID.","in":"path","name":"id","required":true,"schema":{"description":"The agent's ID.","title":"Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"db652d24-b1cc-49be-8eb5-f9af820c478e":{"description":"The `ETag` from your last read: the change is made only if the resource still has it, otherwise `412`. Optional, except that a change replacing a list needs it (`428` without it).","in":"header","name":"If-Match","required":false,"schema":{"oneOf":[{"type":"string","title":"If-Match","description":"The `ETag` from your last read: the change is made only if the resource still has it, otherwise `412`. Optional, except that a change replacing a list needs it (`428` without it).","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"If-Match","description":"The `ETag` from your last read: the change is made only if the resource still has it, otherwise `412`. Optional, except that a change replacing a list needs it (`428` without it).","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"6e7612d6-d1eb-4e6d-8e89-39111cfde9c1":{"description":"Optional. Must be the key's org.","in":"header","name":"Phonely-Organization","required":false,"schema":{"oneOf":[{"type":"string","title":"Phonely-Organization","description":"Optional. Must be the key's org.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Phonely-Organization","description":"Optional. Must be the key's org.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The settings to change. Only the fields sent change.","properties":{"advanced":{"additionalProperties":false,"properties":{"interruption_word_count":{"oneOf":[{"type":"integer","title":"Interruption Word Count","description":"How many words the caller has to say to interrupt the agent, 1 to 4. `null` resets it to the default calls use.","maximum":4,"minimum":1,"uniqueKey":"advanced.interruption_word_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Interruption Word Count","description":"How many words the caller has to say to interrupt the agent, 1 to 4. `null` resets it to the default calls use.","uniqueKey":"advanced.interruption_word_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.interruption_word_count","typeLabel":"integer | null"},"is_smart_endpointing_enabled":{"oneOf":[{"type":"boolean","title":"Is Smart Endpointing Enabled","description":"Whether the agent judges from what the caller said, not only from silence, when they have finished speaking. `null` resets it to the default calls use.","uniqueKey":"advanced.is_smart_endpointing_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Smart Endpointing Enabled","description":"Whether the agent judges from what the caller said, not only from silence, when they have finished speaking. `null` resets it to the default calls use.","uniqueKey":"advanced.is_smart_endpointing_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.is_smart_endpointing_enabled","typeLabel":"boolean | null"},"knowledge_top_k":{"oneOf":[{"type":"integer","title":"Knowledge Top K","description":"How many knowledge base passages the agent looks at when it answers a question, 1 to 10. `null` resets it to the default calls use.","maximum":10,"minimum":1,"uniqueKey":"advanced.knowledge_top_k.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Knowledge Top K","description":"How many knowledge base passages the agent looks at when it answers a question, 1 to 10. `null` resets it to the default calls use.","uniqueKey":"advanced.knowledge_top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.knowledge_top_k","typeLabel":"integer | null"},"noise_filter":{"oneOf":[{"type":"string","title":"Noise Filter","description":"Known values: `phonely`, `none`, `krisp`, `ai_coustics`. More can be added, so handle values you don't recognize.","x-extensible-enum":["phonely","none","krisp","ai_coustics"],"uniqueKey":"advanced.noise_filter.oneOf.0","typeLabel":"string"},{"type":"null","title":"Noise Filter","description":"How background noise on the caller's side is filtered. `null` resets it to the default calls use.","uniqueKey":"advanced.noise_filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.noise_filter","typeLabel":"string | null"},"response_delay_seconds":{"oneOf":[{"type":"number","title":"Response Delay Seconds","description":"How long the agent waits after the caller stops before it replies, 0.05 to 0.4 seconds. `null` resets it to the default calls use.","maximum":0.4,"minimum":0.05,"uniqueKey":"advanced.response_delay_seconds.oneOf.0","typeLabel":"number"},{"type":"null","title":"Response Delay Seconds","description":"How long the agent waits after the caller stops before it replies, 0.05 to 0.4 seconds. `null` resets it to the default calls use.","uniqueKey":"advanced.response_delay_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.response_delay_seconds","typeLabel":"number | null"},"smart_endpointing_wait_seconds":{"oneOf":[{"type":"number","title":"Smart Endpointing Wait Seconds","description":"With smart endpointing, the longest the agent waits for the caller to finish: above 0, up to 4 seconds. Kept while smart endpointing is off. `null` resets it to the default calls use.","maximum":4,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"advanced.smart_endpointing_wait_seconds.oneOf.0","typeLabel":"number"},{"type":"null","title":"Smart Endpointing Wait Seconds","description":"With smart endpointing, the longest the agent waits for the caller to finish: above 0, up to 4 seconds. Kept while smart endpointing is off. `null` resets it to the default calls use.","uniqueKey":"advanced.smart_endpointing_wait_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.smart_endpointing_wait_seconds","typeLabel":"number | null"},"transcriber":{"oneOf":[{"type":"string","title":"Transcriber","description":"The speech-to-text engine, one of those the web app offers the agent. Changing it keeps only the agent's languages it supports. `null` resets it to the default calls use.","uniqueKey":"advanced.transcriber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Transcriber","description":"The speech-to-text engine, one of those the web app offers the agent. Changing it keeps only the agent's languages it supports. `null` resets it to the default calls use.","uniqueKey":"advanced.transcriber.oneOf.1","typeLabel":"null"}],"uniqueKey":"advanced.transcriber","typeLabel":"string | null"}},"title":"AgentAdvancedSettingsUpdate","type":"object","description":"Listening and response fine-tuning.","uniqueKey":"advanced","typeLabel":"AgentAdvancedSettingsUpdate · object"},"call":{"additionalProperties":false,"properties":{"is_sms_continuation_enabled":{"oneOf":[{"type":"boolean","title":"Is Sms Continuation Enabled","description":"Whether the agent can carry on the conversation by text message after the call. Turning it on needs one of the agent's phone numbers registered for texting (`409 sms_setup_required` otherwise). `null` resets it to the default calls use.","uniqueKey":"call.is_sms_continuation_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Sms Continuation Enabled","description":"Whether the agent can carry on the conversation by text message after the call. Turning it on needs one of the agent's phone numbers registered for texting (`409 sms_setup_required` otherwise). `null` resets it to the default calls use.","uniqueKey":"call.is_sms_continuation_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.is_sms_continuation_enabled","typeLabel":"boolean | null"},"is_time_limit_message_skipped":{"oneOf":[{"type":"boolean","title":"Is Time Limit Message Skipped","description":"Whether the call ends at the time limit without `time_limit_message`. `null` resets it to the default calls use.","uniqueKey":"call.is_time_limit_message_skipped.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Time Limit Message Skipped","description":"Whether the call ends at the time limit without `time_limit_message`. `null` resets it to the default calls use.","uniqueKey":"call.is_time_limit_message_skipped.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.is_time_limit_message_skipped","typeLabel":"boolean | null"},"is_transfer_tone_enabled":{"oneOf":[{"type":"boolean","title":"Is Transfer Tone Enabled","description":"Whether a tone plays when a transferred person joins the call. `null` resets it to the default calls use.","uniqueKey":"call.is_transfer_tone_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Transfer Tone Enabled","description":"Whether a tone plays when a transferred person joins the call. `null` resets it to the default calls use.","uniqueKey":"call.is_transfer_tone_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.is_transfer_tone_enabled","typeLabel":"boolean | null"},"silence_check_message":{"oneOf":[{"type":"string","title":"Silence Check Message","description":"What the agent says when it checks in, up to 200 characters. Kept in either mode. `null` or blank text resets it to the default calls use.","uniqueKey":"call.silence_check_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Silence Check Message","description":"What the agent says when it checks in, up to 200 characters. Kept in either mode. `null` or blank text resets it to the default calls use.","uniqueKey":"call.silence_check_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.silence_check_message","typeLabel":"string | null"},"silence_check_mode":{"oneOf":[{"type":"string","title":"Silence Check Mode","description":"Known values: `fixed`, `ai_generated`. More can be added, so handle values you don't recognize.","x-extensible-enum":["fixed","ai_generated"],"uniqueKey":"call.silence_check_mode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Silence Check Mode","description":"How the agent checks in: `fixed` or `ai_generated`. `null` resets it to the default calls use.","uniqueKey":"call.silence_check_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.silence_check_mode","typeLabel":"string | null"},"silence_check_prompt":{"oneOf":[{"type":"string","title":"Silence Check Prompt","description":"The instruction the agent writes its check-in from, up to 200 characters. Kept in either mode. `null` or blank text resets it to the default calls use.","uniqueKey":"call.silence_check_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Silence Check Prompt","description":"The instruction the agent writes its check-in from, up to 200 characters. Kept in either mode. `null` or blank text resets it to the default calls use.","uniqueKey":"call.silence_check_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.silence_check_prompt","typeLabel":"string | null"},"silence_check_retries":{"oneOf":[{"type":"integer","title":"Silence Check Retries","description":"How many times the agent checks in before it ends the call, 1 to 5. `null` resets it to the default calls use.","maximum":5,"minimum":1,"uniqueKey":"call.silence_check_retries.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Silence Check Retries","description":"How many times the agent checks in before it ends the call, 1 to 5. `null` resets it to the default calls use.","uniqueKey":"call.silence_check_retries.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.silence_check_retries","typeLabel":"integer | null"},"silence_timeout_seconds":{"oneOf":[{"type":"number","title":"Silence Timeout Seconds","description":"How long the caller can stay silent before the agent checks in, 3 to 45 seconds. `null` resets it to the default calls use.","maximum":45,"minimum":3,"uniqueKey":"call.silence_timeout_seconds.oneOf.0","typeLabel":"number"},{"type":"null","title":"Silence Timeout Seconds","description":"How long the caller can stay silent before the agent checks in, 3 to 45 seconds. `null` resets it to the default calls use.","uniqueKey":"call.silence_timeout_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.silence_timeout_seconds","typeLabel":"number | null"},"time_limit_message":{"oneOf":[{"type":"string","title":"Time Limit Message","description":"What the agent says when a call reaches the time limit, up to 300 characters. `null` or blank text resets it to the default calls use.","uniqueKey":"call.time_limit_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Time Limit Message","description":"What the agent says when a call reaches the time limit, up to 300 characters. `null` or blank text resets it to the default calls use.","uniqueKey":"call.time_limit_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.time_limit_message","typeLabel":"string | null"},"time_limit_minutes":{"oneOf":[{"type":"number","title":"Time Limit Minutes","description":"The longest a call can last, 0.25 to 60 minutes. `null` resets it to the default calls use.","maximum":60,"minimum":0.25,"uniqueKey":"call.time_limit_minutes.oneOf.0","typeLabel":"number"},{"type":"null","title":"Time Limit Minutes","description":"The longest a call can last, 0.25 to 60 minutes. `null` resets it to the default calls use.","uniqueKey":"call.time_limit_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.time_limit_minutes","typeLabel":"number | null"},"time_zone":{"oneOf":[{"type":"string","title":"Time Zone","description":"The time zone, as an IANA name such as `America/Los_Angeles`. `null` resets it to the default calls use.","uniqueKey":"call.time_zone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Time Zone","description":"The time zone, as an IANA name such as `America/Los_Angeles`. `null` resets it to the default calls use.","uniqueKey":"call.time_zone.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.time_zone","typeLabel":"string | null"}},"title":"AgentCallSettingsUpdate","type":"object","description":"Timing and silence handling on calls.","uniqueKey":"call","typeLabel":"AgentCallSettingsUpdate · object"},"compliance":{"additionalProperties":false,"properties":{"is_recording_enabled":{"oneOf":[{"type":"boolean","title":"Is Recording Enabled","description":"Whether calls are recorded. `null` resets it to the default calls use.","uniqueKey":"compliance.is_recording_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Recording Enabled","description":"Whether calls are recorded. `null` resets it to the default calls use.","uniqueKey":"compliance.is_recording_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.is_recording_enabled","typeLabel":"boolean | null"},"is_transfer_recorded":{"oneOf":[{"type":"boolean","title":"Is Transfer Recorded","description":"Whether recording continues after a call is transferred. It can only be turned on while recording is on; turning recording off leaves it as it is. `null` resets it to the default calls use.","uniqueKey":"compliance.is_transfer_recorded.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Transfer Recorded","description":"Whether recording continues after a call is transferred. It can only be turned on while recording is on; turning recording off leaves it as it is. `null` resets it to the default calls use.","uniqueKey":"compliance.is_transfer_recorded.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.is_transfer_recorded","typeLabel":"boolean | null"}},"title":"AgentComplianceSettingsUpdate","type":"object","description":"Recording.","uniqueKey":"compliance","typeLabel":"AgentComplianceSettingsUpdate · object"}},"title":"AgentSettingsUpdate","type":"object","uniqueKey":"","typeLabel":"AgentSettingsUpdate · object"},"examples":{"Example":{"title":"Example","value":{"advanced":{"interruption_word_count":2,"is_smart_endpointing_enabled":true,"knowledge_top_k":5,"noise_filter":"\u003cstring>","response_delay_seconds":0.225,"smart_endpointing_wait_seconds":2,"transcriber":"\u003cstring>"},"call":{"is_sms_continuation_enabled":true,"is_time_limit_message_skipped":true,"is_transfer_tone_enabled":true,"silence_check_message":"\u003cstring>","silence_check_mode":"\u003cstring>","silence_check_prompt":"\u003cstring>","silence_check_retries":3,"silence_timeout_seconds":24,"time_limit_message":"\u003cstring>","time_limit_minutes":30.125,"time_zone":"\u003cstring>"},"compliance":{"is_recording_enabled":true,"is_transfer_recorded":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"fdaa5e63-ef9f-4b58-8046-40fa4a8039bf":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"How an agent handles calls: timing, recording and compliance, and fine-tuning.","properties":{"advanced":{"additionalProperties":false,"properties":{"interruption_word_count":{"description":"How many words the caller has to say to interrupt the agent.","title":"Interruption Word Count","type":"integer","isRequired":true,"uniqueKey":"advanced.interruption_word_count","typeLabel":"integer"},"is_smart_endpointing_enabled":{"description":"Whether the agent judges from what the caller said, not only from silence, when they have finished speaking.","title":"Is Smart Endpointing Enabled","type":"boolean","isRequired":true,"uniqueKey":"advanced.is_smart_endpointing_enabled","typeLabel":"boolean"},"knowledge_top_k":{"description":"How many knowledge base passages the agent looks at when it answers a question.","title":"Knowledge Top K","type":"integer","isRequired":true,"uniqueKey":"advanced.knowledge_top_k","typeLabel":"integer"},"noise_filter":{"description":"How background noise on the caller's side is filtered. `phonely` is Phonely's recommended filter. Known values: `phonely`, `none`, `krisp`, `ai_coustics`, `viva`. More can be added, so handle values you don't recognize.","title":"Noise Filter","type":"string","x-extensible-enum":["phonely","none","krisp","ai_coustics","viva"],"isRequired":true,"uniqueKey":"advanced.noise_filter","typeLabel":"string"},"response_delay_seconds":{"description":"How long the agent waits after the caller stops before it replies.","title":"Response Delay Seconds","type":"number","isRequired":true,"uniqueKey":"advanced.response_delay_seconds","typeLabel":"number"},"smart_endpointing_wait_seconds":{"description":"With smart endpointing, the longest the agent waits for the caller to finish.","title":"Smart Endpointing Wait Seconds","type":"number","isRequired":true,"uniqueKey":"advanced.smart_endpointing_wait_seconds","typeLabel":"number"},"transcriber":{"description":"The speech-to-text engine that hears the caller. `phonely` is Phonely's recommended engine.","title":"Transcriber","type":"string","isRequired":true,"uniqueKey":"advanced.transcriber","typeLabel":"string"}},"required":["noise_filter","transcriber","response_delay_seconds","interruption_word_count","is_smart_endpointing_enabled","smart_endpointing_wait_seconds","knowledge_top_k"],"title":"AgentAdvancedSettings","type":"object","description":"Listening and response fine-tuning.","isRequired":true,"uniqueKey":"advanced","typeLabel":"AgentAdvancedSettings · object"},"agent_id":{"description":"The agent's ID.","title":"Agent Id","type":"string","isRequired":true,"uniqueKey":"agent_id","typeLabel":"string"},"call":{"additionalProperties":false,"properties":{"is_sms_continuation_enabled":{"description":"Whether the agent can carry on the conversation by text message after the call.","title":"Is Sms Continuation Enabled","type":"boolean","isRequired":true,"uniqueKey":"call.is_sms_continuation_enabled","typeLabel":"boolean"},"is_time_limit_message_skipped":{"description":"Whether the call ends at the time limit without `time_limit_message`.","title":"Is Time Limit Message Skipped","type":"boolean","isRequired":true,"uniqueKey":"call.is_time_limit_message_skipped","typeLabel":"boolean"},"is_transfer_tone_enabled":{"description":"Whether a tone plays when a transferred person joins the call.","title":"Is Transfer Tone Enabled","type":"boolean","isRequired":true,"uniqueKey":"call.is_transfer_tone_enabled","typeLabel":"boolean"},"silence_check_message":{"oneOf":[{"type":"string","title":"Silence Check Message","description":"What the agent says when it checks in, in `fixed` mode. `null` when it is empty.","isRequired":true,"uniqueKey":"call.silence_check_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Silence Check Message","description":"What the agent says when it checks in, in `fixed` mode. `null` when it is empty.","isRequired":true,"uniqueKey":"call.silence_check_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"call.silence_check_message","typeLabel":"string | null"},"silence_check_mode":{"description":"How the agent checks in: with `silence_check_message`, or with words it writes from `silence_check_prompt`. Known values: `fixed`, `ai_generated`. More can be added, so handle values you don't recognize.","title":"Silence Check Mode","type":"string","x-extensible-enum":["fixed","ai_generated"],"isRequired":true,"uniqueKey":"call.silence_check_mode","typeLabel":"string"},"silence_check_prompt":{"oneOf":[{"type":"string","title":"Silence Check Prompt","description":"The instruction the agent writes its check-in from, in `ai_generated` mode. `null` when it is empty.","isRequired":true,"uniqueKey":"call.silence_check_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Silence Check Prompt","description":"The instruction the agent writes its check-in from, in `ai_generated` mode. `null` when it is empty.","isRequired":true,"uniqueKey":"call.silence_check_prompt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"call.silence_check_prompt","typeLabel":"string | null"},"silence_check_retries":{"description":"How many times the agent checks in before it ends the call.","title":"Silence Check Retries","type":"integer","isRequired":true,"uniqueKey":"call.silence_check_retries","typeLabel":"integer"},"silence_timeout_seconds":{"description":"How long the caller can stay silent before the agent checks in.","title":"Silence Timeout Seconds","type":"number","isRequired":true,"uniqueKey":"call.silence_timeout_seconds","typeLabel":"number"},"time_limit_message":{"oneOf":[{"type":"string","title":"Time Limit Message","description":"What the agent says when a call reaches the time limit. `null` when it is empty.","isRequired":true,"uniqueKey":"call.time_limit_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Time Limit Message","description":"What the agent says when a call reaches the time limit. `null` when it is empty.","isRequired":true,"uniqueKey":"call.time_limit_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"call.time_limit_message","typeLabel":"string | null"},"time_limit_minutes":{"description":"The longest a call can last.","title":"Time Limit Minutes","type":"number","isRequired":true,"uniqueKey":"call.time_limit_minutes","typeLabel":"number"},"time_zone":{"description":"The agent's time zone, as an IANA name such as `America/Los_Angeles`.","title":"Time Zone","type":"string","isRequired":true,"uniqueKey":"call.time_zone","typeLabel":"string"}},"required":["time_zone","silence_timeout_seconds","silence_check_retries","silence_check_mode","silence_check_message","silence_check_prompt","time_limit_minutes","time_limit_message","is_time_limit_message_skipped","is_transfer_tone_enabled","is_sms_continuation_enabled"],"title":"AgentCallSettings","type":"object","description":"Timing and silence handling on calls.","isRequired":true,"uniqueKey":"call","typeLabel":"AgentCallSettings · object"},"compliance":{"additionalProperties":false,"properties":{"is_hipaa_enabled":{"description":"Whether the agent handles calls under HIPAA. Only Phonely can change it; it's read-only here.","title":"Is Hipaa Enabled","type":"boolean","isRequired":true,"uniqueKey":"compliance.is_hipaa_enabled","typeLabel":"boolean"},"is_recording_enabled":{"description":"Whether calls are recorded.","title":"Is Recording Enabled","type":"boolean","isRequired":true,"uniqueKey":"compliance.is_recording_enabled","typeLabel":"boolean"},"is_transfer_recorded":{"description":"Whether recording continues after a call is transferred.","title":"Is Transfer Recorded","type":"boolean","isRequired":true,"uniqueKey":"compliance.is_transfer_recorded","typeLabel":"boolean"}},"required":["is_recording_enabled","is_transfer_recorded","is_hipaa_enabled"],"title":"AgentComplianceSettings","type":"object","description":"Recording and compliance.","isRequired":true,"uniqueKey":"compliance","typeLabel":"AgentComplianceSettings · object"},"object":{"const":"agent_settings","default":"agent_settings","description":"The type of this object, always `agent_settings`.","title":"Object","type":"string","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"required":["object","agent_id","call","compliance","advanced"],"title":"AgentSettings","type":"object","uniqueKey":"","typeLabel":"AgentSettings · object"},"examples":{"Example":{"title":"Example","value":{"advanced":{"interruption_word_count":123,"is_smart_endpointing_enabled":true,"knowledge_top_k":123,"noise_filter":"\u003cstring>","response_delay_seconds":123,"smart_endpointing_wait_seconds":123,"transcriber":"\u003cstring>"},"agent_id":"\u003cstring>","call":{"is_sms_continuation_enabled":true,"is_time_limit_message_skipped":true,"is_transfer_tone_enabled":true,"silence_check_message":"\u003cstring>","silence_check_mode":"\u003cstring>","silence_check_prompt":"\u003cstring>","silence_check_retries":123,"silence_timeout_seconds":123,"time_limit_message":"\u003cstring>","time_limit_minutes":123,"time_zone":"\u003cstring>"},"compliance":{"is_hipaa_enabled":true,"is_recording_enabled":true,"is_transfer_recorded":true},"object":"agent_settings"}}},"exampleType":"generated"}},"description":"Successful Response","headers":{"ETag":{"description":"The resource's current version. Send it as `If-Match` to change it only if it's unchanged.","schema":{"type":"string"}},"Phonely-Organization":{"description":"The authorized organization for this request.","schema":{"type":"string"}}},"exampleType":"generated"},"7425f789-1ec3-4008-b090-ae4d5390965a":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The request is invalid: a malformed body, a bad or unknown field, or an unknown query parameter.","exampleType":"generated"},"f757b4dd-a442-4571-b10e-f58c489e5c63":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The API key is missing, invalid or revoked.","headers":{"WWW-Authenticate":{"description":"Always `Bearer`.","schema":{"type":"string"}}},"exampleType":"generated"},"b29e5865-23ac-4e09-a9de-16017aa877bd":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The key can't do this: a read-only key writing, or `Phonely-Organization` naming another org.","exampleType":"generated"},"96e1ebee-5cd6-4bb6-b682-a8a193be1284":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The resource doesn't exist, or belongs to another organization.","exampleType":"generated"},"167fb8cb-6dc9-4ea0-8fac-b6b4adadb528":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"`sms_setup_required`: texting after calls can't be turned on before one of the agent's phone numbers is registered for texting in the web app.","exampleType":"generated"},"1e05e12e-6907-432a-aae8-224e05094f1b":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"`If-Match` isn't the resource's current `ETag`: it changed since you read it.","exampleType":"generated"},"573d8dca-af0d-4e14-a9bb-707aba3d38e8":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Rate limited. Retry after the number of seconds in `Retry-After`.","headers":{"Retry-After":{"description":"Seconds until the request can be retried.","schema":{"type":"integer"}}},"exampleType":"generated"},"9315a4d8-5dcd-48e3-850a-7225f805c511":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"An unexpected error. Contact support with the request ID.","exampleType":"generated"},"7d6e6ba0-0ba3-464a-b200-eb0000a07cc6":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of every `/v1` error.","properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"What went wrong, stable and machine-readable. Known values: `validation_failed`, `invalid_cursor`, `invalid_api_key`, `invalid_user_token`, `user_unavailable`, `insufficient_access`, `organization_mismatch`, `forbidden`, `not_found`, `method_not_allowed`, `conflict`, `agent_limit_reached`, `agent_too_large`, `sms_setup_required`, `opportunity_analysis_not_set_up`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `precondition_required`, `rate_limited`, `internal_error`, `knowledge_processing_failed`, `bad_gateway`, `service_unavailable`, `gateway_timeout`. More can be added, so handle values you don't recognize.","title":"Code","type":"string","x-extensible-enum":["validation_failed","invalid_cursor","invalid_api_key","invalid_user_token","user_unavailable","insufficient_access","organization_mismatch","forbidden","not_found","method_not_allowed","conflict","agent_limit_reached","agent_too_large","sms_setup_required","opportunity_analysis_not_set_up","precondition_failed","payload_too_large","unsupported_media_type","precondition_required","rate_limited","internal_error","knowledge_processing_failed","bad_gateway","service_unavailable","gateway_timeout"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"description":"One entry per problem field. Empty when the error has none.","items":{"additionalProperties":false,"properties":{"field":{"description":"The field the issue is about, as sent: `agent_id`, `limit`. Empty when none.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"description":"What is wrong with the field. Known values: `required`, `unknown_field`, `invalid_json`, `invalid_type`, `invalid_value`, `out_of_range`, `invalid_cursor`, `read_only_field`. More can be added, so handle values you don't recognize.","title":"Issue","type":"string","x-extensible-enum":["required","unknown_field","invalid_json","invalid_type","invalid_value","out_of_range","invalid_cursor","read_only_field"],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"},"message":{"description":"For people: what is wrong with this field.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","issue","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","type":"array","isRequired":true,"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[]"},"message":{"description":"For people. Wording can change; branch on `code`.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the `X-Request-Id` header. Quote it to support.","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message","details","request_id"],"title":"Error","type":"object","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>","message":"\u003cstring>"}],"message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Authentication, authorization or another required service is temporarily unavailable.","exampleType":"generated"}},"security":{"b08c5778-d084-48c9-94db-95852b1eae5b":{"HTTPBearer":{"description":"An org API key: `Authorization: Bearer phk_…`","scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"45f5f669-0210-42d7-9200-2ec9aaf7bbdf":{"description":"US","url":"https://api.us.phonely.ai"},"fe17dd0b-2fbd-41c4-a2c3-cea1c909cb87":{"description":"AU","url":"https://api.au.phonely.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"An org API key: `Authorization: Bearer phk_…`","scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An org API key: `Authorization: Bearer phk_…`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/v1/openapi.json"},"subdomain":"phonely","siteName":"Phonely Documentation","title":"Update settings - Phonely Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/v1/agents/update-settings.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=\"Change an agent\u0026#x27;s settings. Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent\u0026#x27;s settings. Applies from the next call. The web app shows the change and its author at once.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Phonely 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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_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/phonely/pX3uYvY7GANpPgxq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update settings - Phonely Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Change an agent\u0026#x27;s settings. Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent\u0026#x27;s settings. Applies from the next call. The web app shows the change and its author at once.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Phonely Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phonely.ai/api-reference/v1/agents/update-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phonely.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+settings\u0026amp;description=Change+an+agent%27s+settings.%0A%0AOnly+the+fields+sent+change%2C+and+%60null%60+resets+a+field+to+the+default+calls+use.+Answers+with+all+of+the+agent%27s%0Asettings.+Applies+\u0026amp;theme=dc34cb18df25746099d9ebca\u0026amp;signature=32958ce3e445eb1b1469a20a7f81dbb5b9dac537f50bc64b5849abb10d864686\">\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 settings - Phonely Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Change an agent\u0026#x27;s settings. Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent\u0026#x27;s settings. Applies from the next call. The web app shows the change and its author at once.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phonely.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+settings\u0026amp;description=Change+an+agent%27s+settings.%0A%0AOnly+the+fields+sent+change%2C+and+%60null%60+resets+a+field+to+the+default+calls+use.+Answers+with+all+of+the+agent%27s%0Asettings.+Applies+\u0026amp;theme=dc34cb18df25746099d9ebca\u0026amp;signature=32958ce3e445eb1b1469a20a7f81dbb5b9dac537f50bc64b5849abb10d864686\">\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/phonely/pX3uYvY7GANpPgxq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Phonely Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6B0099\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phonely.ai/api-reference/v1/agents/update-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/agents/update-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phonely.ai/#organization\",\"name\":\"Phonely Documentation\",\"url\":\"https://docs.phonely.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phonely/iCxxv_3GatFhm6IZ/logo/logo-purple.png?fit=max\u0026auto=format\u0026n=iCxxv_3GatFhm6IZ\u0026q=85\u0026s=2afc59be170ec958ea83d390334811aa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phonely.ai#website\",\"name\":\"Phonely Documentation\",\"url\":\"https://docs.phonely.ai\",\"publisher\":{\"@id\":\"https://docs.phonely.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings#webpage\",\"url\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings\",\"name\":\"Update settings\",\"description\":\"Change an agent's settings. Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent's settings. Applies from the next call. The web app shows the change and its author at once.\",\"isPartOf\":{\"@id\":\"https://docs.phonely.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API v1 endpoints\",\"item\":\"https://docs.phonely.ai/api-reference/v1/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.phonely.ai/api-reference/v1/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update settings\",\"item\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings#apireference\",\"headline\":\"Update settings\",\"name\":\"Update settings\",\"description\":\"Change an agent's settings. Only the fields sent change, and null resets a field to the default calls use. Answers with all of the agent's settings. Applies from the next call. The web app shows the change and its author at once.\",\"url\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phonely.ai/api-reference/v1/agents/update-settings#webpage\"},\"publisher\":{\"@id\":\"https://docs.phonely.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phonely.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Phonely Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Phonely Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/agents/update-settings.md","siteName":"Phonely Documentation","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://app.phonely.ai"},{"anchor":"Community","icon":"users","href":"https://discord.gg/BMHPUaZG37"}]},"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":"/get-started/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API v1","pages":[{"title":"API v1 overview","href":"/api-reference/v1/overview"},{"title":"Authentication","href":"/api-reference/v1/authentication"},{"title":"Errors and retries","href":"/api-reference/v1/errors"},{"title":"Pagination","href":"/api-reference/v1/pagination"},{"title":"Updates and concurrency","href":"/api-reference/v1/updates-and-concurrency"},{"title":"Versioning and stability","href":"/api-reference/v1/versioning"},{"title":"Migrate from the legacy API","href":"/api-reference/v1/migrate-from-legacy"},{"title":"API v1 changelog","href":"/api-reference/v1/changelog"}]},{"group":"API v1 endpoints","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/agents","href":"/api-reference/v1/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}","href":"/api-reference/v1/agents/get-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}","href":"/api-reference/v1/agents/update-an-agent"},{"title":"List blocked numbers","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/blocked-numbers","href":"/api-reference/v1/agents/list-blocked-numbers"},{"title":"Add a blocked number","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/blocked-numbers","href":"/api-reference/v1/agents/add-a-blocked-number"},{"title":"Remove a blocked number","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json delete /v1/agents/{id}/blocked-numbers/{phone_number}","href":"/api-reference/v1/agents/remove-a-blocked-number"},{"title":"Get call analysis","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/call-analysis","href":"/api-reference/v1/agents/get-call-analysis"},{"title":"Update call analysis","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/call-analysis","href":"/api-reference/v1/agents/update-call-analysis"},{"title":"Duplicate an agent","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/duplicate","href":"/api-reference/v1/agents/duplicate-an-agent"},{"title":"Get guidelines","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/guidelines","href":"/api-reference/v1/agents/get-guidelines"},{"title":"Update guidelines","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/guidelines","href":"/api-reference/v1/agents/update-guidelines"},{"title":"List an agent's knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/knowledge-sources","href":"/api-reference/v1/agents/list-an-agents-knowledge-sources"},{"title":"Add a knowledge document","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/knowledge-sources","href":"/api-reference/v1/agents/add-a-knowledge-document"},{"title":"Upload a knowledge file","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/knowledge-sources/files","href":"/api-reference/v1/agents/upload-a-knowledge-file"},{"title":"Discover website pages","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/knowledge-sources/website-map","href":"/api-reference/v1/agents/discover-website-pages"},{"title":"Add knowledge website pages","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /v1/agents/{id}/knowledge-sources/websites","href":"/api-reference/v1/agents/add-knowledge-website-pages"},{"title":"Get settings","description":"An agent's call settings, compliance settings and advanced settings, as the web app shows them.\n\nA setting nobody has changed shows the value calls use.","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/settings","href":"/api-reference/v1/agents/get-settings"},{"title":"Update settings","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/settings","href":"/api-reference/v1/agents/update-settings"},{"title":"Get an agent's voice","description":"An agent's voice, as its Voice settings in the web app show it.\n\nA setting nobody has changed shows the value calls use.","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json get /v1/agents/{id}/voice","href":"/api-reference/v1/agents/get-an-agents-voice"},{"title":"Update an agent's voice","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v1/openapi.json patch /v1/agents/{id}/voice","href":"/api-reference/v1/agents/update-an-agents-voice"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/calls","href":"/api-reference/v1/calls/list-calls"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/calls/{id}","href":"/api-reference/v1/calls/get-a-call"},{"title":"Set a call's outcome","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /v1/calls/{id}","href":"/api-reference/v1/calls/set-a-calls-outcome"},{"title":"Get a call recording","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/calls/{id}/recording","href":"/api-reference/v1/calls/get-a-call-recording"},{"title":"Get a call transcript","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/calls/{id}/transcript","href":"/api-reference/v1/calls/get-a-call-transcript"}]},{"group":"Knowledge sources","pages":[{"title":"Get a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/knowledge-sources/{id}","href":"/api-reference/v1/knowledge-sources/get-a-knowledge-source"},{"title":"Delete a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json delete /v1/knowledge-sources/{id}","href":"/api-reference/v1/knowledge-sources/delete-a-knowledge-source"},{"title":"Update a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /v1/knowledge-sources/{id}","href":"/api-reference/v1/knowledge-sources/update-a-knowledge-source"},{"title":"Get a file download link","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/knowledge-sources/{id}/download","href":"/api-reference/v1/knowledge-sources/get-a-file-download-link"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/organizations","href":"/api-reference/v1/organizations/list-organizations"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/organizations/{id}","href":"/api-reference/v1/organizations/get-an-organization"},{"title":"List usage","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/organizations/{id}/usage","href":"/api-reference/v1/organizations/list-usage"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/voices","href":"/api-reference/v1/voices/list-voices"},{"title":"Get a voice","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /v1/voices/{id}","href":"/api-reference/v1/voices/get-a-voice"}]}]},{"group":"Legacy API","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Agent Generation","pages":[{"title":"Generate an Agent","openapi":"POST /agent-generations","href":"/api-reference/endpoint/generate-agent"},{"title":"Generation Status","openapi":"GET /agent-generations/{generationId}","href":"/api-reference/endpoint/get-agent-generation"}]},{"group":"Agent Management","pages":[{"title":"Get Agent","openapi":"POST /get-agent","href":"/api-reference/endpoint/get-agent"},{"title":"Get Agents","openapi":"POST /get-agents","href":"/api-reference/endpoint/get-agents"},{"title":"Duplicate Agent","openapi":"POST /duplicate-agent","href":"/api-reference/endpoint/duplicate-agent"},{"title":"Update Agent","openapi":"POST /update-agent","href":"/api-reference/endpoint/update-agent"}]},{"group":"Call Management","pages":[{"title":"List Calls","openapi":"GET /calls/{agentId}","href":"/api-reference/endpoint/list-calls"},{"title":"Get Call","openapi":"POST /get-call","href":"/api-reference/endpoint/get-call"},{"title":"Report Call Error","openapi":"POST /report-call-error","href":"/api-reference/endpoint/report-call-error"},{"title":"Set Post-Call Outcome","openapi":"PATCH /calls/{agentId}/{callIdOrPhone}","href":"/api-reference/endpoint/set-post-call-outcome"}]},{"group":"Knowledge Base","pages":[{"title":"List Documents","openapi":"GET /agent-documents","href":"/api-reference/endpoint/agent-documents"},{"title":"Upload Documents","openapi":"POST /agent-documents","href":"/api-reference/endpoint/post-agent-documents"},{"title":"Delete Document","openapi":"DELETE /agent-documents","href":"/api-reference/endpoint/delete-agent-documents"},{"title":"List Websites","openapi":"GET /agent-websites","href":"/api-reference/endpoint/agent-websites"},{"title":"Add Website","openapi":"POST /agent-websites","href":"/api-reference/endpoint/post-agent-websites"},{"title":"Delete Website","openapi":"DELETE /agent-websites","href":"/api-reference/endpoint/delete-agent-websites"}]},{"group":"Voice \u0026 Phone","pages":[{"title":"List Voices","openapi":"GET /list-voices","href":"/api-reference/endpoint/list-voices"},{"title":"Import Number","openapi":"POST /import-number","href":"/api-reference/endpoint/import-number"},{"title":"List Blocked Numbers","openapi":"GET /agent-block-list","href":"/api-reference/endpoint/block-list"},{"title":"Add Blocked Numbers","openapi":"POST /agent-block-list","href":"/api-reference/endpoint/add-blocked-numbers"},{"title":"Remove Blocked Numbers","openapi":"DELETE /agent-block-list","href":"/api-reference/endpoint/remove-blocked-numbers"}]},{"group":"Organizations","pages":[{"title":"Get Organizations","openapi":"GET /get-orgs","href":"/api-reference/endpoint/get-orgs"}]}]},{"group":"Web SDK","pages":[{"title":"Web SDK","href":"/api-reference/web-sdk"}]}]}]},"basePath":"","title":"Update settings - Phonely Documentation","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D6S0Yh6q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}