Low-balance notification frequency. Organization sub-users cannot set a non-null frequency. The resulting profile must have both a threshold and frequency, or neither.
Data locality: USA (United States), DEU (Germany), AUS (Australia), UAE (United Arab Emirates), or CAN (Canada). A change is permitted only if data locality has not previously been changed. A successful change sets data_locality_updated_at and initializes data_locality_migration_status to not_started.
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Telnyx","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","colors":{"primary":"#00B688","light":"#00B688","dark":"#00B688"},"logo":{"light":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=5ee3f61d11ba90a197dd9a1e3499fab6","dark":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo-dark.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=d65aaa12ec708c79e5833cbdea958055"},"favicon":"https://mintcdn.com/telnyx/t-qaBUa_gCxdRz_m/favicon.ico?fit=max\u0026auto=format\u0026n=t-qaBUa_gCxdRz_m\u0026q=85\u0026s=8291283238ab8c0e2a7a985e69f38c2f","background":{"decoration":"gradient"},"navbar":{"links":[{"icon":"triangle-exclamation","href":"/docs/development/api-fundamentals/api-errors","label":"Error codes"},{"icon":"headset","href":"https://telnyx.com/contact-us","label":"Contact us"},{"icon":"user","href":"https://portal.telnyx.com/#/login/sign-in","label":"Login"}],"primary":{"type":"button","label":"Sign Up","href":"https://telnyx.com/sign-up"}},"footer":{"socials":{"github":"https://github.com/team-telnyx","linkedin":"https://www.linkedin.com/company/telnyx","slack":"https://joinslack.telnyx.com","x":"https://x.com/telnyx"},"links":[{"header":"Resources","items":[{"label":"Pricing","href":"https://developers.telnyx.com/internal/pages/pricing"},{"label":"Compare Telnyx","href":"https://developers.telnyx.com/internal/pages/compare"},{"label":"Support center","href":"https://support.telnyx.com/en"},{"label":"SETI","href":"https://seti.telnyx.com"},{"label":"Agent platform configs","href":"https://github.com/team-telnyx/ai"},{"label":"About Telnyx","href":"https://developers.telnyx.com/internal/pages/about"},{"label":"Service status","href":"https://status.telnyx.com"}]},{"header":"Updates","items":[{"label":"Release notes","href":"https://telnyx.com/release-notes"}]},{"header":"Community","items":[{"label":"Low Latency Club","href":"https://lowlatencyclub.ai/"}]},{"header":"Legal","items":[{"label":"Privacy policy","href":"https://telnyx.com/privacy-policy"},{"label":"Terms and conditions","href":"https://telnyx.com/terms-and-conditions"}]}]},"seo":{"metatags":{"og:description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute"},"organization":{"name":"Telnyx","url":"https://telnyx.com","logo":"https://telnyx.com/favicon.ico","sameAs":["https://x.com/telnyx","https://www.linkedin.com/company/telnyx/","https://github.com/team-telnyx"]}},"fonts":{"heading":{"family":"PP Formula","weight":800,"source":"assets/fonts/PPFormula-Extrabold.woff2","format":"woff2"},"body":{"family":"Inter","weight":400,"source":"assets/fonts/Inter-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-NRRX236"}},"banner":{"content":"Check out our upcoming events and meetups! [View events →](https://lowlatencyclub.ai/)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"telnyx","hasAudioNarration":false,"actualSubdomain":"telnyx","customDomains":["developers.telnyx.com"],"gitSource":{"type":"github","owner":"team-telnyx","repo":"developer-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea286477df7a8c9a9eff7a","collectionId":"9f3b5d7e-768f-4324-a47a-77f6ac373df3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea286477df7a8c9a9eff7a"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea2b3300d9bd74e0860642","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Calling","count":592},{"language":"default","tag":"API Reference","count":552},{"language":"default","tag":"Other APIs","count":406},{"language":"default","tag":"AI","count":382},{"language":"default","tag":"Messaging","count":353},{"language":"default","tag":"Numbers","count":287},{"language":"default","tag":"Agent Platform","count":218},{"language":"default","tag":"Assistants","count":202},{"language":"default","tag":"Voice API","count":178},{"language":"default","tag":"SMS \u0026 MMS","count":149}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"[class*=sidebar] [class*=badge],[class*=sidebar] [class*=tag],nav [class*=badge],nav [class*=tag]{font-size:.8rem!important}#ot-sdk-btn-floating{left:auto!important;right:10px!important}body:has([aria-label=\"Preview Widget\"]) #ot-sdk-btn-floating{bottom:88px!important}#navbar .nav-tabs-item:has(>div>svg[style*=\"/book-open.svg\"]),#navbar div:has(>div>.nav-tabs>a.nav-tabs-item:first-child:last-child){display:none}.nav-tabs a.nav-tabs-item:not([aria-current=location]){display:none}#mobile-nav #navigation-items>div:has(>div>button[aria-haspopup=menu]),#mobile-nav [data-component-part=products-selector-trigger],#mobile-nav.tx-has-directory #navigation-items{display:none!important}#mobile-nav .tx-mobile-directory{padding:0;margin-bottom:1.5rem}#mobile-nav .tx-mobile-directory .tx-dir-suite-head,#mobile-nav .tx-mobile-directory a{min-height:2.75rem}#mobile-nav .tx-mobile-directory :is(a, .tx-dir-suite-head):focus-visible{outline:2px solid currentColor;outline-offset:-2px}.txd-shell{display:flex;gap:0;max-width:none;margin:0;padding:3rem 2rem 6rem 0}.txd-side{width:18rem;flex-shrink:0}.txd-main{flex:1;min-width:0;max-width:56rem;margin-left:11.75rem}@media (max-width:80rem){.txd-main{margin-left:4rem}}:is(#tx-directory, .tx-mobile-directory){margin:0 0 .5rem;padding:0 .5rem 0 1rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label{font-size:.72rem;font-weight:600;letter-spacing:.06em;text-transform:uppercase;opacity:.55;margin:0 0 .4rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label-gap{margin-top:1.5rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link,:is(#tx-directory, .tx-mobile-directory) summary{display:flex;align-items:center;cursor:pointer;font-size:.875rem;line-height:1.25rem;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81);text-decoration:none}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link,html.dark :is(#tx-directory, .tx-mobile-directory) summary{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,:is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#00b688;background:0 0;box-shadow:none;font-weight:400;text-shadow:-.2px 0 0 currentColor,.2px 0 0 currentColor}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,html.dark :is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#5eead4;background:0 0;box-shadow:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover{cursor:default;opacity:.45;background:0 0;color:inherit}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon sup{font-size:.6rem;line-height:1;letter-spacing:.05em;text-transform:uppercase;margin-left:.4rem;vertical-align:super}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite{margin-bottom:.15rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head{display:flex;align-items:center;cursor:pointer;user-select:none;font-size:.875rem;line-height:1.25rem;font-weight:500;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,:is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head::after{content:'';width:.42rem;height:.42rem;margin-left:auto;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(-45deg);transition:transform .15s;flex-shrink:0;opacity:.7}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head::after{transform:rotate(45deg)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head{color:rgb(17 24 39);background:rgb(0 0 0/.04);font-weight:600}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite>ul{display:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>ul{display:block}:is(#tx-directory, .tx-mobile-directory) ul{margin:.15rem 0 .5rem;padding:0}:is(#tx-directory, .tx-mobile-directory) li{list-style:none}:is(#tx-directory, .tx-mobile-directory) li a{display:flex;align-items:center;font-size:.875rem;line-height:1.25rem;padding:.3rem .5rem .3rem 1.6rem;border-radius:.375rem;color:rgb(107 114 128);text-decoration:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-section-item{font-weight:500}:is(#tx-directory, .tx-mobile-directory) .tx-dir-icon{display:inline-block;width:1rem;height:1rem;flex-shrink:0;margin-right:.5rem;background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.txi-arrows-left-right-to-line{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg)}.txi-bolt{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg)}.txi-brain{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg)}.txi-brain-circuit{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg)}.txi-brands-whatsapp{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg)}.txi-broadcast-tower{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg)}.txi-browser{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg)}.txi-circle-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg)}.txi-clone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg)}.txi-cloud{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg)}.txi-code{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg)}.txi-comment-sms{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg)}.txi-cubes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg)}.txi-database{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg)}.txi-envelope{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg)}.txi-eye{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg)}.txi-file-certificate{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg)}.txi-fingerprint{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg)}.txi-folder-tree{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg)}.txi-globe{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg)}.txi-hard-drive{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg)}.txi-hashtag{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg)}.txi-headset{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg)}.txi-key{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg)}.txi-layer-group{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg)}.txi-magnifying-glass{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg)}.txi-message{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg)}.txi-message-dots{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg)}.txi-microchip-ai{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg)}.txi-microphone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg)}.txi-network-wired{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg)}.txi-phone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg)}.txi-phone-volume{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg)}.txi-plug{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg)}.txi-right-left{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg)}.txi-robot{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg)}.txi-server{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg)}.txi-share-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg)}.txi-shield{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg)}.txi-shield-check{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg)}.txi-signal{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg)}.txi-sim-card{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg)}.txi-split{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg)}.txi-table{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg)}.txi-tower-control{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg)}.txi-train-tunnel{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg)}.txi-video{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg)}.txi-wand-magic-sparkles{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg)}.txi-waveform{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg)}.txi-waveform-lines{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg)}.txd-main .txd-h1{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:2.1rem;font-weight:500;letter-spacing:-.01em;margin:1.2rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h1{color:rgb(229 231 235)}.txd-main .txd-lead{font-size:1.3rem;line-height:1.55;font-weight:500;margin:.9rem 0 1.3rem;color:rgb(31 41 55)}html.dark .txd-main .txd-lead{color:rgb(209 213 219)}.txd-main .txd-h2{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:1.45rem;font-weight:500;margin:2.4rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h2{color:rgb(229 231 235)}.txd-main .txd-section-h{font-size:1.05rem;font-weight:600;margin:1.8rem 0 .2rem;opacity:.85}.txd-main .txd-p{margin:.7rem 0 1rem;line-height:1.65;color:rgb(75 85 99)}html.dark .txd-main .txd-p{color:rgb(156 163 175)}.txd-main .txd-follow-up a:hover,.txd-main .txd-p a{text-decoration:underline}.txd-main .txd-h1{max-width:46rem;line-height:1.12}.txd-main .txd-hero-copy{max-width:45rem}.txd-main .txd-follow-up{margin-top:1rem}.txd-main .txd-follow-up a{color:#00b688;font-weight:600;text-decoration:none}.txd-main a:focus-visible{outline:2px solid #00b688;outline-offset:3px}@media (max-width:48rem){.txd-main .txd-h1{font-size:1.9rem}}@media (min-width:64.01rem) and (max-width:90rem){.txd-main{margin-right:4rem}}.rm-explorer{--rm-border:rgb(15 23 42 / 14%);--rm-muted:#5f6b68;--rm-soft:#f6f8f7}.dark .rm-explorer{--rm-border:rgb(255 255 255 / 14%);--rm-muted:#a2aaa8;--rm-soft:#151a19}#resource-map-toolbar{position:sticky;top:5rem;z-index:20;margin:1.25rem 0 1.75rem;padding:.75rem 0;background:var(--rm-surface, #fff);border-bottom:1px solid var(--rm-border)}.dark #resource-map-toolbar{background:#0b0e0d}.rm-controls{display:grid;grid-template-columns:minmax(15rem,1fr) minmax(10rem,auto) auto;gap:.625rem;align-items:center}.rm-search{position:relative;min-width:0}.rm-search svg{position:absolute;top:50%;left:.75rem;width:1rem;height:1rem;color:var(--rm-muted);fill:none;stroke:currentColor;stroke-width:1.8;transform:translateY(-50%);pointer-events:none}.rm-area-select,.rm-collapse,.rm-search input{min-height:2.5rem;font-size:.875rem}.rm-area-select,.rm-clear,.rm-collapse,.rm-empty button,.rm-search input{color:inherit;background:0 0;border:1px solid var(--rm-border);border-radius:.5rem;font:inherit}.rm-empty button{font-size:.875rem}.rm-search input{width:100%;padding:.58rem 2.6rem .58rem 2.35rem}.rm-search input::placeholder{color:var(--rm-muted);opacity:1}.rm-shortcut{position:absolute;top:50%;right:.65rem;display:grid;width:1.5rem;height:1.5rem;place-items:center;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.35rem;font:inherit;font-size:.72rem;transform:translateY(-50%);pointer-events:none}.rm-area-wrap{position:relative;max-width:13rem}.rm-area-select{width:100%;max-width:13rem;padding:.55rem 2.25rem .55rem .75rem;appearance:none;cursor:pointer}.rm-area-caret{position:absolute;top:50%;right:.85rem;width:.45rem;height:.45rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:translateY(-70%) rotate(45deg);pointer-events:none}.rm-collapse{padding:.5rem .75rem}.rm-clear,.rm-collapse,.rm-empty button{font-weight:650;cursor:pointer}.rm-empty button{padding:.5rem .75rem}.rm-area-select:focus-visible,.rm-clear:focus-visible,.rm-collapse:focus-visible,.rm-empty button:focus-visible,.rm-search input:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-color:#00b688;box-shadow:none!important}.rm-clear:hover,.rm-collapse:hover,.rm-empty button:hover{color:#08785d;background:var(--rm-soft)}.dark .rm-clear:hover,.dark .rm-collapse:hover,.dark .rm-empty button:hover{color:#5eead4}.rm-meta{display:flex;min-height:1.65rem;align-items:center;justify-content:space-between;gap:.75rem;padding:.45rem .15rem 0}.rm-status{color:var(--rm-muted);font-size:.78rem;line-height:1.35}.rm-clear{min-height:1.8rem;padding:.2rem .55rem;border-color:transparent;font-size:.78rem}.rm-empty{display:grid;justify-items:start;gap:.35rem;margin:-.5rem 0 1.75rem;padding:1.1rem 1.2rem;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.75rem;font-size:.875rem}.rm-empty strong{color:inherit;font-size:.95rem}.rm-empty button{min-height:2.2rem;margin-top:.35rem}.rm-resource-list{display:block!important;margin:0 0 .75rem!important;border-color:var(--rm-border)!important;border-top:0!important;border-radius:0 0 .75rem .75rem!important}.rm-resource-list>details.accordion{margin:0!important;border:0!important;border-radius:0!important}.rm-resource-list>details.accordion+details.accordion{border-top:1px solid var(--rm-border)!important}.rm-resource-list>details.accordion>summary{min-height:3rem;padding:.7rem .9rem!important;border-radius:0!important}.rm-resource-list>details.accordion:first-child>summary{border-radius:0!important}.rm-resource-list>details.accordion:last-child:not([open])>summary{border-radius:0 0 .75rem .75rem!important}.rm-resource-list [data-component-part=accordion-title]{display:flex;min-width:0;align-items:baseline;justify-content:space-between;gap:1rem}.rm-resource-name{min-width:0;overflow-wrap:anywhere;font-weight:650}.rm-method-count{flex:0 0 auto;color:var(--rm-muted);font-size:.75rem;font-weight:500;white-space:nowrap}.rm-resource-list details[open]>summary{background:var(--rm-soft)}.rm-resource-list details[open] [data-component-part=accordion-content]{margin-right:1rem;margin-left:1rem}.rm-resource-list tbody tr.rm-row-match{background:rgb(0 182 136/8%)}.rm-resource-list td:first-child code{white-space:nowrap}.rm-clear[hidden],.rm-collapse[hidden],.rm-empty[hidden],.rm-explorer h2[hidden],.rm-resource-list tbody tr[hidden],.rm-resource-list[hidden]{display:none!important}.rm-explorer h2{position:relative;min-height:3rem;margin:.45rem 0 0!important;scroll-margin-top:10rem;border:1px solid var(--rm-border);border-radius:.75rem}.rm-explorer h2.rm-section-open{border-radius:.75rem .75rem 0 0}.rm-section-toggle{display:grid;width:100%;min-height:3rem;grid-template-columns:minmax(0,1fr) auto auto;align-items:center;gap:.75rem;padding:.6rem .9rem;color:inherit;text-align:left;background:0 0;border:0;cursor:pointer}.rm-section-toggle:focus-visible,.rm-section-toggle:hover{background:var(--rm-soft)}.rm-section-toggle:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-radius:.7rem}.rm-section-name{font-size:1rem;font-weight:700}.rm-section-count{display:grid;min-width:1.65rem;min-height:1.4rem;place-items:center;padding:3px 6px;color:#08785d;background:rgb(0 182 136/10%);border-radius:.35rem;font-size:12px;font-weight:700;line-height:16px;white-space:nowrap}.dark .rm-section-count{color:#5eead4;background:#12302b}.rm-section-caret{width:.5rem;height:.5rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(45deg) translateY(-.15rem)}.rm-section-toggle[aria-expanded=true] .rm-section-caret{transform:rotate(225deg) translate(-.1rem,-.05rem)}@media (max-width:767px){#resource-map-toolbar{position:static;top:auto;z-index:auto;margin-top:1rem;padding-top:.6rem}.rm-controls{grid-template-columns:minmax(0,1fr) auto}.rm-search{grid-column:1/-1}.rm-search input{padding-right:.75rem}.rm-resource-list thead,.rm-shortcut{display:none}.rm-area-select,.rm-area-wrap{width:100%;max-width:none}.rm-resource-list [data-component-part=accordion-title]{gap:.65rem}.rm-method-count{font-size:.7rem}.rm-resource-list table,.rm-resource-list tbody{display:block;width:100%;min-width:0!important}.rm-resource-list tbody tr{display:grid;width:100%;grid-template-columns:minmax(0,1fr);gap:.45rem;padding:.75rem 0}.rm-resource-list tbody tr+tr{border-top:1px solid var(--rm-border)}.rm-resource-list tbody td{display:grid;width:100%;min-width:0!important;grid-template-columns:4.5rem minmax(0,1fr);align-items:start;gap:.5rem;padding:0!important;border:0!important}.rm-resource-list tbody td::before{color:var(--rm-muted);font-size:.68rem;font-weight:700;letter-spacing:.04em;text-transform:uppercase}.rm-resource-list tbody td:first-child::before{content:\"Method\"}.rm-resource-list tbody td:last-child::before{content:\"Endpoint\"}.rm-resource-list tbody td a,.rm-resource-list tbody td code{min-width:0;white-space:normal!important;overflow-wrap:anywhere}}@media (prefers-reduced-motion:reduce){.rm-explorer *,.rm-explorer ::after,.rm-explorer ::before{scroll-behavior:auto!important;transition-duration:.01ms!important}}.sdk-launchpad{--sdk-border:#d8e1de;--sdk-panel:#ffffff;margin:1rem 0 1.5rem;padding:1rem;overflow:hidden;color:inherit;background:var(--sdk-panel);border:1px solid var(--sdk-border);border-radius:12px}.dark .sdk-launchpad{--sdk-border:#293431;--sdk-panel:#101513}.sdk-launchpad-kicker{margin:0 0 .25rem!important;color:#08785d;font-size:.68rem;font-weight:800;letter-spacing:.1em}.dark .sdk-launchpad-kicker{color:#5eead4}.sdk-launchpad>h2{margin-top:.25rem}.sdk-launchpad [role=tablist]{display:flex;flex-wrap:wrap;gap:.25rem}.sdk-launchpad [role=tab]{min-width:56px;min-height:44px}.sdk-launchpad [role=tab][aria-selected=true]{color:#08785d!important}.dark .sdk-launchpad [role=tab][aria-selected=true]{color:#5eead4!important}.sdk-launchpad [role=tab]:focus-visible,.sdk-launchpad a:focus-visible,.sdk-launchpad-code:focus-visible{outline:2px solid #08785d;outline-offset:2px}.dark .sdk-launchpad [role=tab]:focus-visible,.dark .sdk-launchpad a:focus-visible,.dark .sdk-launchpad-code:focus-visible{outline-color:#5eead4}.sdk-launchpad-code{max-width:100%;overflow-x:auto;border-radius:.5rem}.sdk-launchpad-code pre{max-width:none;overflow-x:visible!important}.sdk-launchpad-code button{min-width:44px;min-height:44px}#content-area:has(#sdk-launchpad) .chat-assistant-floating-input{display:none}@media (max-width:640px){.sdk-launchpad{margin-top:.75rem;padding:.75rem}.sdk-launchpad-kicker{display:none}.sdk-launchpad [role=tablist]{display:grid;grid-template-columns:repeat(6,minmax(0,1fr));gap:.2rem;overflow:visible}.sdk-launchpad [role=tab]{min-width:0;min-height:44px;padding-inline:.2rem;font-size:.75rem;line-height:1.15;white-space:nowrap}}.sdk-directory li{margin-block:.5rem}.mdx-content table td{min-width:0!important}.mdx-content table td :is(code, a){overflow-wrap:anywhere}.mdx-content table :is(th, td):first-child code{white-space:nowrap;word-break:normal;overflow-wrap:normal}@media (min-width:768px){.tx-table-grid table{table-layout:fixed}.tx-table-grid table :is(th, td):first-child{width:40%}}.tx-retirement-banner{margin-bottom:1.5rem}.tx-retirement-banner>div{margin:0}@media (min-width:1024px){.tx-retirement-banner{position:sticky;top:calc(6rem + var(--banner-height, 0px));z-index:20;padding-top:.5rem;background:rgb(var(--background-light, 255 255 255))}.dark .tx-retirement-banner{background:rgb(var(--background-dark, 9 12 14))}}#content>.callout:first-child{margin-top:0}#content strong{font-weight:600}"}],"page":{"pagePath":"api-reference/user-profile/update-the-current-user-profile-beta","slug":"/api-reference/user-profile/update-the-current-user-profile-beta","pageMetadata":{"title":"Update the current user profile (Beta)","description":"Update the authenticated user's profile using top-level JSON fields. Returns the updated profile.\n\n**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json patch /user_profile","href":"/api-reference/user-profile/update-the-current-user-profile-beta","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 p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update the authenticated user’s profile using top-level JSON fields. Returns the updated profile.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Beta:\"\n }), \" this API should be considered a beta integration target because it may change if user account settings require changes\"]\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 the current user profile (Beta)","description":"Update the authenticated user's profile using top-level JSON fields. Returns the updated profile.\n\n**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json patch /user_profile","href":"/api-reference/user-profile/update-the-current-user-profile-beta","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/telnyx/a2dd5aaa2ff5831a/reading-progress.js","/_mintlify/custom/telnyx/7b77ce9cedb163fd/webmcp-init.js","/_mintlify/custom/telnyx/7fbfee588ac7ad38/structured-data.js","/_mintlify/custom/telnyx/41d9633b1a2dd405/scripts/tests/generate-llms-txt.test.js","/_mintlify/custom/telnyx/8851ad5fd6e9b5c7/scripts/tests/direct-source-workflows.test.js","/_mintlify/custom/telnyx/7ad13bb6588be22f/scripts/tests/redirects.test.js","/_mintlify/custom/telnyx/f981035eb45fcbdb/scripts/tests/generate-error-catalog.test.js","/_mintlify/custom/telnyx/132bc205f55282a5/scripts/tests/sync-llms-automerge.test.js","/_mintlify/custom/telnyx/05e787f15f45952b/scripts/tests/webhook-catalog-lifecycle.test.js","/_mintlify/custom/telnyx/01b840b27496e6c8/scripts/tests/repository-structure.test.js","/_mintlify/custom/telnyx/5ebc7d6e18012563/scripts/tests/legacy-content-usage.test.js","/_mintlify/custom/telnyx/ac1f21e68bf4050a/scripts/docs/check-llms-links.js","/_mintlify/custom/telnyx/5f7d2f1ae375b9ad/scripts/docs/check-llms-native-routes.js","/_mintlify/custom/telnyx/b8d13287c2dcc5b9/scripts/docs/fetch-coverage.js","/_mintlify/custom/telnyx/e0a29f76f2645359/scripts/docs/generate-error-catalog.js","/_mintlify/custom/telnyx/3d8fe29c5f30f1bc/scripts/docs/generate-llms-txt.js","/_mintlify/custom/telnyx/f1f111fe784c3ede/scripts/docs/update-tts-voices.js","/_mintlify/custom/telnyx/c48ad0189f7f1c57/scripts/docs/build-sdk-doc-pages.js","/_mintlify/custom/telnyx/f840117777d76f9e/scripts/tests/sdk-doc-pages.test.js","/_mintlify/custom/telnyx/414c53c50b0e1968/resource-map-filter.js","/_mintlify/custom/telnyx/80af622b3010a712/scripts/tests/sdk-language-switcher.test.js","/_mintlify/custom/telnyx/52fa0fbcb966f8b6/sdk-language-switcher.js","/_mintlify/custom/telnyx/3de33ceedb29f568/home-directory.js","/_mintlify/custom/telnyx/da7a630a1adf8a7a/scripts/generate-home-directory.js","/_mintlify/custom/telnyx/137e3eb8e1d1d85a/scripts/tests/api-fundamentals.test.js","/_mintlify/custom/telnyx/24a8eed3a5010d4c/scripts/tests/agent-sdk-workflow.test.js","/_mintlify/custom/telnyx/abc2169efcd5115c/scripts/tests/homepage-overview.test.js","/_mintlify/custom/telnyx/8edf49ac62deef02/scripts/tests/batch-detail-records-navigation.test.js","/_mintlify/custom/telnyx/e005178572336f01/scripts/tests/api-discoverability.test.js","/_mintlify/custom/telnyx/78cb83896fbea5cf/scripts/tests/home-directory.test.js","/_mintlify/custom/telnyx/11ae45253e6b7be6/scripts/tests/agent-readiness.test.js","/_mintlify/custom/telnyx/82396d5a75077c2a/scripts/tests/sample-workflow-regressions.test.js","/_mintlify/custom/telnyx/5f6625c0420c9328/scripts/tests/openapi-mintlify-parsing.test.js","/_mintlify/custom/telnyx/c7dca602ca9641ec/scripts/tests/llms-markdown-assets.test.js","/_mintlify/custom/telnyx/02d6acd7c86b79f9/scripts/tests/agent-browser-quickstart.test.js"],"openApiReferenceData":{"operation":{"operationId":"UpdateUserProfile","summary":"Update the current user profile (Beta)","description":"Update the authenticated user's profile using top-level JSON fields. Returns the updated profile.\n\n**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes","tags":["User Profile"],"x-beta":true,"requestBody":"1fbe5cf6-df95-43bf-adce-968d373b321d","responses":{"200":"568154fc-f84f-423d-b685-07671d174157","401":"b80baf81-c317-4ff4-bbb7-f8e110feefb3","403":"58b052c4-e92b-4092-bf2b-b990c73ed5cb","422":"d1c810b4-b00f-426e-b726-7c7b0459f7c1"},"method":"patch","type":"path","servers":["16ca8c65-67f2-4a3e-bd05-53e84f3bf6c4"],"security":["0e57f150-70b3-4c60-85d1-8d9843686f3b"],"path":"/user_profile","baseUrlOptions":["https://api.telnyx.com/v2"],"title":"Update the current user profile (Beta)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Profile fields to update. Omitted fields retain their current values.","properties":{"first_name":{"oneOf":[{"type":"string","description":"The user's first name.","example":"Alex","maxLength":100,"uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's first name.","example":"Alex","maxLength":100,"uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The user's last name.","example":"Taylor","maxLength":100,"uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's last name.","example":"Taylor","maxLength":100,"uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","description":"Business name associated with the profile.","example":"Example Company","maxLength":255,"uniqueKey":"business_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business name associated with the profile.","example":"Example Company","maxLength":255,"uniqueKey":"business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_name","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","description":"Contact phone number associated with the profile.","example":"+13125550100","uniqueKey":"phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact phone number associated with the profile.","example":"+13125550100","uniqueKey":"phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_number","typeLabel":"string | null"},"address_1":{"oneOf":[{"type":"string","description":"First line of the profile address.","example":"123 Example Street","uniqueKey":"address_1.oneOf.0","typeLabel":"string"},{"type":"null","description":"First line of the profile address.","example":"123 Example Street","uniqueKey":"address_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_1","typeLabel":"string | null"},"address_2":{"oneOf":[{"type":"string","description":"Second line of the profile address.","example":"Suite 100","uniqueKey":"address_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of the profile address.","example":"Suite 100","uniqueKey":"address_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City in the profile address.","example":"Chicago","uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City in the profile address.","example":"Chicago","uniqueKey":"city.oneOf.1","typeLabel":"null"}],"uniqueKey":"city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or region in the profile address.","example":"IL","uniqueKey":"state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or region in the profile address.","example":"IL","uniqueKey":"state.oneOf.1","typeLabel":"null"}],"uniqueKey":"state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"Postal code in the profile address.","example":"60601","uniqueKey":"zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code in the profile address.","example":"60601","uniqueKey":"zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"zip","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country code in the profile address.","example":"US","uniqueKey":"country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country code in the profile address.","example":"US","uniqueKey":"country.oneOf.1","typeLabel":"null"}],"uniqueKey":"country","typeLabel":"string | null"},"got_free_number_at_signup":{"type":"boolean","description":"Whether the user received a free number at signup.","example":false,"uniqueKey":"got_free_number_at_signup","typeLabel":"boolean"},"ui_theme":{"type":"integer","description":"User interface theme: 0 for dark or 1 for light.","example":1,"enum":[0,1],"uniqueKey":"ui_theme","typeLabel":"enum\u003cinteger>"},"low_balance_threshold_amount":{"oneOf":[{"type":"number","description":"Low-balance notification threshold in the billing currency. The resulting profile must have both a threshold and notification frequency, or neither.","example":10,"uniqueKey":"low_balance_threshold_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Low-balance notification threshold in the billing currency. The resulting profile must have both a threshold and notification frequency, or neither.","example":10,"uniqueKey":"low_balance_threshold_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"low_balance_threshold_amount","typeLabel":"number | null"},"low_balance_notification_frequency":{"oneOf":[{"type":"integer","description":"Low-balance notification frequency. Organization sub-users cannot set a non-null frequency. The resulting profile must have both a threshold and frequency, or neither.","example":12,"enum":[2,4,12,24,null],"uniqueKey":"low_balance_notification_frequency.oneOf.0","typeLabel":"enum\u003cinteger>"},{"type":"null","description":"Low-balance notification frequency. Organization sub-users cannot set a non-null frequency. The resulting profile must have both a threshold and frequency, or neither.","example":12,"enum":[2,4,12,24,null],"uniqueKey":"low_balance_notification_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"low_balance_notification_frequency","typeLabel":"enum\u003cinteger> | null"},"notify_on_invoice_available":{"type":"boolean","description":"Whether to notify the user when an invoice is available.","example":true,"uniqueKey":"notify_on_invoice_available","typeLabel":"boolean"},"notify_on_invoice_payment":{"type":"boolean","description":"Whether to notify the user when an invoice is paid.","example":false,"uniqueKey":"notify_on_invoice_payment","typeLabel":"boolean"},"primary_use_case":{"type":"string","description":"Primary use case for the account.","example":"configure sip trunks","uniqueKey":"primary_use_case","typeLabel":"string"},"default_numbers_external_pin":{"type":"string","description":"Default alphanumeric external PIN for phone numbers.","example":"1234","minLength":4,"maxLength":16,"uniqueKey":"default_numbers_external_pin","typeLabel":"string"},"role":{"type":"string","description":"The user's role.","example":"account manager","uniqueKey":"role","typeLabel":"string"},"company_size":{"type":"string","description":"Company size reported by the user.","example":"11-50","uniqueKey":"company_size","typeLabel":"string"},"npac_user":{"type":"boolean","description":"Whether the user is an NPAC user.","example":false,"uniqueKey":"npac_user","typeLabel":"boolean"},"user_subscription_opt_in":{"type":"boolean","description":"Whether the user opts in to subscriptions.","example":false,"uniqueKey":"user_subscription_opt_in","typeLabel":"boolean"},"default_managed_account_allow_custom_pricing":{"type":"boolean","description":"Default custom-pricing setting for managed accounts.","example":false,"uniqueKey":"default_managed_account_allow_custom_pricing","typeLabel":"boolean"},"default_managed_account_rollup_billing":{"type":"boolean","description":"Default rollup-billing setting for managed accounts.","example":false,"uniqueKey":"default_managed_account_rollup_billing","typeLabel":"boolean"},"default_notify_manager_account":{"type":"boolean","description":"Default setting for notifying the manager account.","example":true,"uniqueKey":"default_notify_manager_account","typeLabel":"boolean"},"port_out_pin_validation":{"type":"boolean","description":"Whether port-out PIN validation is enabled.","example":false,"uniqueKey":"port_out_pin_validation","typeLabel":"boolean"},"default_managed_account_inherit_emergency_terms_of_service":{"type":"boolean","description":"Default emergency terms-of-service inheritance setting for managed accounts, where supported.","example":false,"uniqueKey":"default_managed_account_inherit_emergency_terms_of_service","typeLabel":"boolean"},"data_locality":{"type":"string","enum":["USA","DEU","AUS","UAE","CAN"],"description":"Data locality: USA (United States), DEU (Germany), AUS (Australia), UAE (United Arab Emirates), or CAN (Canada). A change is permitted only if data locality has not previously been changed. A successful change sets data_locality_updated_at and initializes data_locality_migration_status to not_started.","example":"DEU","uniqueKey":"data_locality","typeLabel":"enum\u003cstring>"},"use_cases":{"type":"array","description":"Use cases reported by the user.","items":{"type":"string","uniqueKey":"use_cases.items.[INDEX]","typeLabel":"string"},"example":["voice"],"uniqueKey":"use_cases","typeLabel":"string[]"},"onboarding_use_cases_other":{"type":"array","description":"Other onboarding use cases.","items":{"type":"string","uniqueKey":"onboarding_use_cases_other.items.[INDEX]","typeLabel":"string"},"example":["customer support"],"uniqueKey":"onboarding_use_cases_other","typeLabel":"string[]"},"onboarding_project_types":{"type":"array","description":"Onboarding project types.","items":{"type":"string","uniqueKey":"onboarding_project_types.items.[INDEX]","typeLabel":"string"},"example":["contact center"],"uniqueKey":"onboarding_project_types","typeLabel":"string[]"},"onboarding_reasons_for_consideration":{"type":"array","description":"Reasons for considering Telnyx.","items":{"type":"string","uniqueKey":"onboarding_reasons_for_consideration.items.[INDEX]","typeLabel":"string"},"example":["API integration"],"uniqueKey":"onboarding_reasons_for_consideration","typeLabel":"string[]"},"onboarding_industries":{"type":"array","description":"Industries reported during onboarding.","items":{"type":"string","uniqueKey":"onboarding_industries.items.[INDEX]","typeLabel":"string"},"example":["software"],"uniqueKey":"onboarding_industries","typeLabel":"string[]"},"onboarding_monthly_budget":{"type":"array","description":"Monthly budget ranges reported during onboarding.","items":{"type":"string","uniqueKey":"onboarding_monthly_budget.items.[INDEX]","typeLabel":"string"},"example":["1000-5000"],"uniqueKey":"onboarding_monthly_budget","typeLabel":"string[]"},"onboarding_referrer":{"type":"array","description":"Referral sources reported during onboarding.","items":{"type":"string","uniqueKey":"onboarding_referrer.items.[INDEX]","typeLabel":"string"},"example":["search engine"],"uniqueKey":"onboarding_referrer","typeLabel":"string[]"},"onboarding_build_method":{"type":"array","description":"Build methods reported during onboarding.","items":{"type":"string","uniqueKey":"onboarding_build_method.items.[INDEX]","typeLabel":"string"},"example":["API"],"uniqueKey":"onboarding_build_method","typeLabel":"string[]"},"onboarding_product_interest":{"type":"array","description":"Products of interest reported during onboarding.","items":{"type":"string","maxLength":255,"uniqueKey":"onboarding_product_interest.items.[INDEX]","typeLabel":"string"},"example":["voice"],"maxItems":20,"uniqueKey":"onboarding_product_interest","typeLabel":"string[]"}},"example":{"first_name":"Alex","last_name":"Taylor","ui_theme":1},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"first_name":"Alex","last_name":"Taylor","ui_theme":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"568154fc-f84f-423d-b685-07671d174157":{"description":"The updated user profile.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"The authenticated user's profile.","additionalProperties":true,"properties":{"record_type":{"type":"string","enum":["user_profile"],"description":"Identifies the type of resource.","example":"user_profile","uniqueKey":"data.record_type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"Identifier of the user profile, distinct from the user ID.","example":12345,"uniqueKey":"data.id","typeLabel":"integer"},"user_id":{"type":"string","description":"Identifier of the user who owns this profile.","example":"12ade33a-21c0-473b-b055-b3c836e1c292","uniqueKey":"data.user_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the most recent profile update.","example":"2026-01-15T10:30:00Z","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"first_name":{"oneOf":[{"type":"string","description":"The user's first name.","example":"Alex","uniqueKey":"data.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's first name.","example":"Alex","uniqueKey":"data.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The user's last name.","example":"Taylor","uniqueKey":"data.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's last name.","example":"Taylor","uniqueKey":"data.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","description":"Business name associated with the profile.","example":"Example Company","uniqueKey":"data.business_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business name associated with the profile.","example":"Example Company","uniqueKey":"data.business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.business_name","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","description":"Contact phone number associated with the profile.","example":"+13125550100","uniqueKey":"data.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact phone number associated with the profile.","example":"+13125550100","uniqueKey":"data.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.phone_number","typeLabel":"string | null"},"address_1":{"oneOf":[{"type":"string","description":"First line of the profile address.","example":"123 Example Street","uniqueKey":"data.address_1.oneOf.0","typeLabel":"string"},{"type":"null","description":"First line of the profile address.","example":"123 Example Street","uniqueKey":"data.address_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address_1","typeLabel":"string | null"},"address_2":{"oneOf":[{"type":"string","description":"Second line of the profile address.","example":"Suite 100","uniqueKey":"data.address_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of the profile address.","example":"Suite 100","uniqueKey":"data.address_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address_2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City in the profile address.","example":"Chicago","uniqueKey":"data.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City in the profile address.","example":"Chicago","uniqueKey":"data.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or region in the profile address.","example":"IL","uniqueKey":"data.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or region in the profile address.","example":"IL","uniqueKey":"data.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"Postal code in the profile address.","example":"60601","uniqueKey":"data.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code in the profile address.","example":"60601","uniqueKey":"data.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.zip","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country code in the profile address.","example":"US","uniqueKey":"data.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country code in the profile address.","example":"US","uniqueKey":"data.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.country","typeLabel":"string | null"},"data_locality":{"oneOf":[{"type":"string","enum":["USA","DEU","AUS","UAE","CAN",null],"description":"The user's data locality: USA (United States), DEU (Germany), AUS (Australia), UAE (United Arab Emirates), or CAN (Canada).","example":"UAE","uniqueKey":"data.data_locality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["USA","DEU","AUS","UAE","CAN",null],"description":"The user's data locality: USA (United States), DEU (Germany), AUS (Australia), UAE (United Arab Emirates), or CAN (Canada).","example":"UAE","uniqueKey":"data.data_locality.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.data_locality","typeLabel":"enum\u003cstring> | null"},"data_locality_updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the user's data locality was last changed, or null if it has not been changed.","example":"2026-01-15T10:00:00Z","uniqueKey":"data.data_locality_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the user's data locality was last changed, or null if it has not been changed.","example":"2026-01-15T10:00:00Z","uniqueKey":"data.data_locality_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.data_locality_updated_at","typeLabel":"string\u003cdate-time> | null"},"data_locality_migration_status":{"oneOf":[{"type":"string","enum":["not_started","in_progress","finished",null],"description":"Status of the user's data locality migration, or null when no migration status is recorded.","example":"finished","uniqueKey":"data.data_locality_migration_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["not_started","in_progress","finished",null],"description":"Status of the user's data locality migration, or null when no migration status is recorded.","example":"finished","uniqueKey":"data.data_locality_migration_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.data_locality_migration_status","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"record_type":"user_profile","id":12345,"user_id":"12ade33a-21c0-473b-b055-b3c836e1c292","updated_at":"2026-01-15T10:30:00Z","first_name":"Alex","last_name":"Taylor","business_name":"Example Company","data_locality":"UAE","data_locality_updated_at":"2026-01-15T10:00:00Z","data_locality_migration_status":"finished"}},"examples":{"Example":{"title":"Example","value":{"data":{"record_type":"user_profile","id":12345,"user_id":"12ade33a-21c0-473b-b055-b3c836e1c292","updated_at":"2026-01-15T10:30:00Z","first_name":"Alex","last_name":"Taylor","business_name":"Example Company","data_locality":"UAE","data_locality_updated_at":"2026-01-15T10:00:00Z","data_locality_migration_status":"finished"}}}},"exampleType":"examples"}},"exampleType":"examples"},"b80baf81-c317-4ff4-bbb7-f8e110feefb3":{"description":"Authentication failed. Supply a valid API key using Bearer authentication.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"58b052c4-e92b-4092-bf2b-b990c73ed5cb":{"description":"The authenticated user is not permitted to access this resource.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d1c810b4-b00f-426e-b726-7c7b0459f7c1":{"description":"Validation failed, such as an invalid field value, an invalid address, a disallowed data-locality change, or an organization sub-user attempting to change low-balance notification frequency.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"API error code.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Error title.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"Explanation of the error.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string","description":"Pointer to the invalid field.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"type":"object","additionalProperties":true,"description":"Additional error metadata.","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"10027","title":"Unprocessable Entity","detail":"is not an acceptable value","source":{"pointer":"/data_locality"},"meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10027"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"10027","title":"Unprocessable Entity","detail":"is not an acceptable value","source":{"pointer":"/data_locality"},"meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10027"}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0e57f150-70b3-4c60-85d1-8d9843686f3b":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"16ca8c65-67f2-4a3e-bd05-53e84f3bf6c4":{"url":"https://api.telnyx.com/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/source/external/user-profile/user-profile.json"},"subdomain":"telnyx","siteName":"Telnyx","title":"Update the current user profile (Beta) - Telnyx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T18:33:42.888Z","originalFileLocation":"api-reference/user-profile/update-the-current-user-profile-beta.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update the authenticated user\u0026#x27;s profile using top-level JSON fields. Returns the updated profile. Beta: this API should be considered a beta integration target because it may change if user account settings require changes\">\u003cmeta data-mint-head name=\"application-name\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_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/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update the current user profile (Beta) - Telnyx\">\u003cmeta data-mint-head property=\"og:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Telnyx\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=User+Profile\u0026amp;title=Update+the+current+user+profile+%28Beta%29\u0026amp;description=Update+the+authenticated+user%27s+profile+using+top-level+JSON+fields.+Returns+the+updated+profile.%0A%0A**Beta%3A**+this+API+should+be+considered+a+beta+integration+ta\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=f44faad1ba1cd8ab32616dbbed39331dbfdba6a239adc61cbd0af8dc189d8634\">\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 the current user profile (Beta) - Telnyx\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=User+Profile\u0026amp;title=Update+the+current+user+profile+%28Beta%29\u0026amp;description=Update+the+authenticated+user%27s+profile+using+top-level+JSON+fields.+Returns+the+updated+profile.%0A%0A**Beta%3A**+this+API+should+be+considered+a+beta+integration+ta\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=f44faad1ba1cd8ab32616dbbed39331dbfdba6a239adc61cbd0af8dc189d8634\">\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/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B688\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/user-profile/update-the-current-user-profile-beta.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://telnyx.com/#organization\",\"name\":\"Telnyx\",\"url\":\"https://telnyx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://telnyx.com/favicon.ico\"},\"sameAs\":[\"https://x.com/telnyx\",\"https://www.linkedin.com/company/telnyx/\",\"https://github.com/team-telnyx\"]},{\"@type\":\"WebSite\",\"@id\":\"https://developers.telnyx.com#website\",\"name\":\"Telnyx\",\"url\":\"https://developers.telnyx.com\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta#webpage\",\"url\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta\",\"name\":\"Update the current user profile (Beta)\",\"description\":\"Update the authenticated user's profile using top-level JSON fields. Returns the updated profile. Beta: this API should be considered a beta integration target because it may change if user account settings require changes\",\"dateModified\":\"2026-11-03T18:33:42.888Z\",\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account \u0026 Billing\",\"item\":\"https://developers.telnyx.com/api-reference/user-profile/retrieve-the-current-user-profile-beta\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"User Profile\",\"item\":\"https://developers.telnyx.com/api-reference/user-profile/retrieve-the-current-user-profile-beta\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update the current user profile (Beta)\",\"item\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta#apireference\",\"headline\":\"Update the current user profile (Beta)\",\"name\":\"Update the current user profile (Beta)\",\"description\":\"Update the authenticated user's profile using top-level JSON fields. Returns the updated profile. Beta: this API should be considered a beta integration target because it may change if user account settings require changes\",\"url\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta\",\"mainEntityOfPage\":{\"@id\":\"https://developers.telnyx.com/api-reference/user-profile/update-the-current-user-profile-beta#webpage\"},\"dateModified\":\"2026-11-03T18:33:42.888Z\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"}}]}\u003c/script>","siteName":"Telnyx","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"products":[{"product":"Home","icon":"house","pages":[{"title":"Home","href":"/docs/overview"}]},{"product":"Other APIs","icon":"ellipsis","tabs":[{"tab":"Other APIs","icon":"ellipsis","groups":[{"group":" ","pages":[{"title":"Other APIs","href":"/docs/other-apis"}]},{"group":"Account \u0026 Billing","pages":[{"group":"User Profile","pages":[{"title":"Retrieve the current user profile (Beta)","description":"Retrieve the authenticated user's profile, including data locality and migration status.\n\n**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json get /user_profile","href":"/api-reference/user-profile/retrieve-the-current-user-profile-beta"},{"title":"Update the current user profile (Beta)","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json patch /user_profile","href":"/api-reference/user-profile/update-the-current-user-profile-beta"}]},{"group":"Payment APIs","pages":[{"title":"List auto recharge preferences","description":"Returns the payment auto recharge preferences.","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/payment.json get /payment/auto_recharge_prefs","href":"/api-reference/autorechargepreferences/list-auto-recharge-preferences"},{"title":"Update auto recharge preferences","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/payment.json patch /payment/auto_recharge_prefs","href":"/api-reference/autorechargepreferences/update-auto-recharge-preferences"},{"group":"x402 Payment Transactions API","pages":[{"title":"Create a payment quote","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json post /x402/credit_account/quote","href":"/api-reference/x402-payment-transactions/create-a-payment-quote"},{"title":"Settle a payment","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json post /x402/credit_account","href":"/api-reference/x402-payment-transactions/settle-a-payment"},{"title":"List x402 payments","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json get /x402/credit_account/payments","href":"/api-reference/x402-payment-transactions/list-x402-payments"},{"title":"Get an x402 payment","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json get /x402/credit_account/payments/{id}","href":"/api-reference/x402-payment-transactions/get-an-x402-payment"}]},{"group":"Machine Payments API","pages":[{"title":"Create a machine payment account credit","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/machine-payments.json post /machine-payments/account-credit","href":"/api-reference/machine-payments/create-a-machine-payment-account-credit"}]}]},{"group":"Notifications","pages":[{"title":"List notification channels","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_channels","href":"/api-reference/notifications/list-notification-channels"},{"title":"Create a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_channels","href":"/api-reference/notifications/create-a-notification-channel"},{"title":"Delete a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_channels/{id}","href":"/api-reference/notifications/delete-a-notification-channel"},{"title":"Get a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_channels/{id}","href":"/api-reference/notifications/get-a-notification-channel"},{"title":"Update a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json patch /notification_channels/{id}","href":"/api-reference/notifications/update-a-notification-channel"},{"title":"List all Notifications Events Conditions","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_event_conditions","href":"/api-reference/notifications/list-all-notifications-events-conditions"},{"title":"List all Notifications Events","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_events","href":"/api-reference/notifications/list-all-notifications-events"},{"title":"List all Notifications Profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_profiles","href":"/api-reference/notifications/list-all-notifications-profiles"},{"title":"Create a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_profiles","href":"/api-reference/notifications/create-a-notification-profile"},{"title":"Delete a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_profiles/{id}","href":"/api-reference/notifications/delete-a-notification-profile"},{"title":"Get a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_profiles/{id}","href":"/api-reference/notifications/get-a-notification-profile"},{"title":"Update a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json patch /notification_profiles/{id}","href":"/api-reference/notifications/update-a-notification-profile"},{"title":"List notification settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_settings","href":"/api-reference/notifications/list-notification-settings"},{"title":"Add a Notification Setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_settings","href":"/api-reference/notifications/add-a-notification-setting"},{"title":"Delete a notification setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_settings/{id}","href":"/api-reference/notifications/delete-a-notification-setting"},{"title":"Get a notification setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_settings/{id}","href":"/api-reference/notifications/get-a-notification-setting"}]},{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json get /addresses","href":"/api-reference/addresses/list-all-addresses"},{"title":"Creates an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses","href":"/api-reference/addresses/creates-an-address"},{"title":"Deletes an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json delete /addresses/{id}","href":"/api-reference/addresses/deletes-an-address"},{"title":"Retrieve an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json get /addresses/{id}","href":"/api-reference/addresses/retrieve-an-address"},{"title":"Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses/{id}/actions/accept_suggestions","href":"/api-reference/addresses/accepts-this-address-suggestion-as-a-new-emergency-address-for-operator-connect-and-finishes-the-uploads-of-the-numbers-associated-with-it-to-microsoft"},{"title":"Validate an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses/actions/validate","href":"/api-reference/addresses/validate-an-address"}]},{"group":"Balance","pages":[{"title":"Get user balance details","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/billing.json get /balance","href":"/api-reference/billing/get-user-balance-details"}]},{"group":"Charges","pages":[{"title":"Get monthly charges summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/charges.json get /charges_summary","href":"/api-reference/get-monthly-charges-summary"},{"title":"Get monthly charges breakdown","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/charges.json get /charges_breakdown","href":"/api-reference/get-monthly-charges-breakdown"}]},{"group":"Spend limits","pages":[{"title":"List spend limits","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json get /spend_limits","href":"/api-reference/spend-limits/list-spend-limits"},{"title":"Create a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json post /spend_limits","href":"/api-reference/spend-limits/create-a-spend-limit"},{"title":"Update a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json patch /spend_limits/{product}","href":"/api-reference/spend-limits/update-a-spend-limit"},{"title":"Delete a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json delete /spend_limits/{product}","href":"/api-reference/spend-limits/delete-a-spend-limit"}]},{"group":"Stored Payment Transactions API","pages":[{"title":"Create a stored payment transaction","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/stored-payment-transactions.json post /v2/payment/stored_payment_transactions","href":"/api-reference/stored-payment-transactions/create-a-stored-payment-transaction"}]},{"group":"Pricing","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi/source/external/pricing/pricing.json get /pricing/products","href":"/api-reference/pricing/list-products"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openapi/source/external/pricing/pricing.json get /pricing/products/{slug}","href":"/api-reference/pricing/get-product-pricing"}]},{"group":"Authentication providers","pages":[{"title":"List all SSO authentication providers","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json get /authentication_providers","href":"/api-reference/authentication-providers/list-all-sso-authentication-providers"},{"title":"Creates an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json post /authentication_providers","href":"/api-reference/authentication-providers/creates-an-authentication-provider"},{"title":"Deletes an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json delete /authentication_providers/{id}","href":"/api-reference/authentication-providers/deletes-an-authentication-provider"},{"title":"Retrieve an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json get /authentication_providers/{id}","href":"/api-reference/authentication-providers/retrieve-an-authentication-provider"},{"title":"Update an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json patch /authentication_providers/{id}","href":"/api-reference/authentication-providers/update-an-authentication-provider"}]},{"group":"IP addresses","pages":[{"group":"IP Addresses API","pages":[{"title":"List all Access IP Addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_address","href":"/api-reference/ip-addresses/list-all-access-ip-addresses"},{"title":"Create new Access IP Address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json post /access_ip_address","href":"/api-reference/ip-addresses/create-new-access-ip-address"},{"title":"Delete access IP address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json delete /access_ip_address/{access_ip_address_id}","href":"/api-reference/ip-addresses/delete-access-ip-address"},{"title":"Retrieve an access IP address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_address/{access_ip_address_id}","href":"/api-reference/ip-addresses/retrieve-an-access-ip-address"}]},{"group":"IP Ranges API","pages":[{"title":"List all Access IP Ranges","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_ranges","href":"/api-reference/ip-ranges/list-all-access-ip-ranges"},{"title":"Create new Access IP Range","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json post /access_ip_ranges","href":"/api-reference/ip-ranges/create-new-access-ip-range"},{"title":"Delete access IP ranges","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json delete /access_ip_ranges/{access_ip_range_id}","href":"/api-reference/ip-ranges/delete-access-ip-ranges"}]}]},{"group":"Managed accounts","pages":[{"group":"Managed Accounts API","pages":[{"title":"Lists accounts managed by the current user.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts","href":"/api-reference/managed-accounts/lists-accounts-managed-by-the-current-user"},{"title":"Create a new managed account.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts","href":"/api-reference/managed-accounts/create-a-new-managed-account"},{"title":"Retrieve a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts/{id}","href":"/api-reference/managed-accounts/retrieve-a-managed-account"},{"title":"Update a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json patch /managed_accounts/{id}","href":"/api-reference/managed-accounts/update-a-managed-account"},{"title":"Disables a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts/{id}/actions/disable","href":"/api-reference/managed-accounts/disables-a-managed-account"},{"title":"Enables a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts/{id}/actions/enable","href":"/api-reference/managed-accounts/enables-a-managed-account"},{"title":"Update the amount of allocatable global outbound channels allocated to a specific managed account.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json patch /managed_accounts/{id}/update_global_channel_limit","href":"/api-reference/managed-accounts/update-the-amount-of-allocatable-global-outbound-channels-allocated-to-a-specific-managed-account"},{"title":"Display information about allocatable global outbound channels for the current user.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts/allocatable_global_outbound_channels","href":"/api-reference/managed-accounts/display-information-about-allocatable-global-outbound-channels-for-the-current-user"}]},{"group":"Organization Users API","pages":[{"title":"List organization users","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users","href":"/api-reference/organization-users/list-organization-users"},{"title":"Get organization user","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users/{id}","href":"/api-reference/organization-users/get-organization-user"},{"title":"Delete organization user","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json post /organizations/users/{id}/actions/remove","href":"/api-reference/organization-users/delete-organization-user"},{"title":"Get organization users groups report","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users/users_groups_report","href":"/api-reference/organization-users/get-organization-users-groups-report"}]}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/invoice.json get /invoices","href":"/api-reference/list-invoices"},{"title":"Get invoice by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/invoice.json get /invoices/{id}","href":"/api-reference/get-invoice-by-id"}]},{"group":"Billing groups","pages":[{"title":"List all billing groups","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json get /billing_groups","href":"/api-reference/billing-groups/list-all-billing-groups"},{"title":"Create a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json post /billing_groups","href":"/api-reference/billing-groups/create-a-billing-group"},{"title":"Delete a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json delete /billing_groups/{id}","href":"/api-reference/billing-groups/delete-a-billing-group"},{"title":"Get a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json get /billing_groups/{id}","href":"/api-reference/billing-groups/get-a-billing-group"},{"title":"Update a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json patch /billing_groups/{id}","href":"/api-reference/billing-groups/update-a-billing-group"}]},{"group":"Detail records","pages":[{"title":"Search detail records","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/detail-records.json get /detail_records","href":"/api-reference/detail-records/search-detail-records"}]},{"group":"Batch detail records","pages":[{"group":"MDR Detailed Reports API","pages":[{"title":"Get all MDR detailed report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/messaging","href":"/api-reference/mdr-detailed-reports/get-all-mdr-detailed-report-requests"},{"title":"Create a new MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/messaging","href":"/api-reference/mdr-detailed-reports/create-a-new-mdr-detailed-report-request"},{"title":"Get a specific MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/messaging/{id}","href":"/api-reference/mdr-detailed-reports/get-a-specific-mdr-detailed-report-request"},{"title":"Delete a MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/messaging/{id}","href":"/api-reference/mdr-detailed-reports/delete-a-mdr-detailed-report-request"}]},{"group":"CDR Reports API","pages":[{"title":"Get all CDR report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice","href":"/api-reference/cdr-reports/get-all-cdr-report-requests"},{"title":"Create a new CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/voice","href":"/api-reference/cdr-reports/create-a-new-cdr-report-request"},{"title":"Get a specific CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice/{id}","href":"/api-reference/cdr-reports/get-a-specific-cdr-report-request"},{"title":"Delete a CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/voice/{id}","href":"/api-reference/cdr-reports/delete-a-cdr-report-request"},{"title":"Get available CDR report fields","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice/fields","href":"/api-reference/cdr-reports/get-available-cdr-report-fields"}]},{"group":"Speech to Text Batch Reports API","pages":[{"title":"Get all Speech to Text batch report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/speech_to_text","href":"/api-reference/speech-to-text-batch-reports/get-all-speech-to-text-batch-report-requests"},{"title":"Create a new Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/speech_to_text","href":"/api-reference/speech-to-text-batch-reports/create-a-new-speech-to-text-batch-report-request"},{"title":"Get a specific Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/speech_to_text/{id}","href":"/api-reference/speech-to-text-batch-reports/get-a-specific-speech-to-text-batch-report-request"},{"title":"Delete a Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/speech_to_text/{id}","href":"/api-reference/speech-to-text-batch-reports/delete-a-speech-to-text-batch-report-request"}]}]},{"group":"Usage reports","pages":[{"title":"Usage Reports","href":"/docs/reporting/usage-reports/index"},{"group":"MDR Usage Reports API","pages":[{"title":"List MDR usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/messaging","href":"/api-reference/mdr-usage-reports/list-mdr-usage-reports"},{"title":"Create a new legacy usage V2 MDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/messaging","href":"/api-reference/mdr-usage-reports/create-a-new-legacy-usage-v2-mdr-report-request"},{"title":"Get an MDR usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/messaging/{id}","href":"/api-reference/mdr-usage-reports/get-an-mdr-usage-report"},{"title":"Delete a V2 legacy usage MDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/messaging/{id}","href":"/api-reference/mdr-usage-reports/delete-a-v2-legacy-usage-mdr-report-request"},{"title":"Fetch all Messaging usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports","href":"/api-reference/mdr-usage-reports/fetch-all-messaging-usage-reports"},{"title":"Create MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json post /reports/mdr_usage_reports","href":"/api-reference/mdr-usage-reports/create-mdr-usage-report"},{"title":"Retrieve messaging report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports/{id}","href":"/api-reference/mdr-usage-reports/retrieve-messaging-report"},{"title":"Delete MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json delete /reports/mdr_usage_reports/{id}","href":"/api-reference/mdr-usage-reports/delete-mdr-usage-report"},{"title":"Generate and fetch MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports/sync","href":"/api-reference/mdr-usage-reports/generate-and-fetch-mdr-usage-report"}]},{"group":"Telco Data Usage Reports API","pages":[{"title":"List telco data usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/number_lookup","href":"/api-reference/telco-data-usage-reports/list-telco-data-usage-reports"},{"title":"Submit telco data usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/number_lookup","href":"/api-reference/telco-data-usage-reports/submit-telco-data-usage-report"},{"title":"Get telco data usage report by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/number_lookup/{id}","href":"/api-reference/telco-data-usage-reports/get-telco-data-usage-report-by-id"},{"title":"Delete telco data usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/number_lookup/{id}","href":"/api-reference/telco-data-usage-reports/delete-telco-data-usage-report"}]},{"group":"Speech to text Usage Reports API","pages":[{"title":"Get speech to text usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/speech_to_text","href":"/api-reference/speech-to-text-usage-reports/get-speech-to-text-usage-report"}]},{"group":"CDR Usage Reports API","pages":[{"title":"List CDR usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/voice","href":"/api-reference/cdr-usage-reports/list-cdr-usage-reports"},{"title":"Create a new legacy usage V2 CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/voice","href":"/api-reference/cdr-usage-reports/create-a-new-legacy-usage-v2-cdr-report-request"},{"title":"Get a CDR usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/voice/{id}","href":"/api-reference/cdr-usage-reports/get-a-cdr-usage-report"},{"title":"Delete a V2 legacy usage CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/voice/{id}","href":"/api-reference/cdr-usage-reports/delete-a-v2-legacy-usage-cdr-report-request"},{"title":"Generates and fetches CDR Usage Reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/cdr_usage_reports/sync","href":"/api-reference/cdr-usage-reports/generates-and-fetches-cdr-usage-reports"}]},{"group":"Usage Reports (BETA) API","pages":[{"title":"Get Telnyx product usage data (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/usage-reports.json get /usage_reports","href":"/api-reference/usage-reports-beta/get-telnyx-product-usage-data-beta"},{"title":"Get Usage Reports query options (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/usage-reports.json get /usage_reports/options","href":"/api-reference/usage-reports-beta/get-usage-reports-query-options-beta"}]},{"group":"MDR Detail Reports API","pages":[{"title":"Fetch all Mdr records","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdrs","href":"/api-reference/mdr-detail-reports/fetch-all-mdr-records"}]},{"group":"WDR Detail Reports API","pages":[{"title":"Fetches all Wdr records","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/wireless-public.json get /reports/wdrs","href":"/api-reference/wdr-detail-reports/fetches-all-wdr-records"}]}]},{"group":"Session analysis","pages":[{"title":"Session Analysis API: trace session costs and event trees","sidebarTitle":"Session Analysis","href":"/docs/reporting/session-analysis/index"},{"title":"Get metadata overview","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/metadata","href":"/api-reference/session-analysis/get-metadata-overview"},{"title":"Get record type metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/metadata/{record_type}","href":"/api-reference/session-analysis/get-record-type-metadata"},{"title":"Get session analysis","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/{record_type}/{event_id}","href":"/api-reference/session-analysis/get-session-analysis"}]},{"group":"On-Demand Reports","pages":[{"title":"On-Demand Reports","href":"/docs/reporting/on-demand-reports/index"}]},{"group":"Webhooks","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi/source/external/webhooks/webhooks.json get /webhook_deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Find webhook_delivery details by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/webhooks/webhooks.json get /webhook_deliveries/{id}","href":"/api-reference/webhooks/find-webhook_delivery-details-by-id"}]},{"group":"Audit trail","pages":[{"title":"List Audit Logs","deprecated":null,"version":null,"openapi":"/openapi/source/external/audit-logs/audit-logs.json get /audit_events","href":"/api-reference/audit-logs/list-audit-logs"}]},{"group":"Taggings","pages":[{"group":"User Tags API","pages":[{"title":"List User Tags","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-tags/user-tags.json get /user_tags","href":"/api-reference/user-tags/list-user-tags"}]},{"group":"UserAddresses API","pages":[{"title":"List all user addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json get /user/addresses","href":"/api-reference/useraddresses/list-all-user-addresses"},{"title":"Creates a user address","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json post /user/addresses","href":"/api-reference/useraddresses/creates-a-user-address"},{"title":"Retrieve a user address","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json get /user/addresses/{id}","href":"/api-reference/useraddresses/retrieve-a-user-address"}]}]},{"group":"Integration Secrets","pages":[{"title":"List integration secrets","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json get /integration_secrets","href":"/api-reference/integration-secrets/list-integration-secrets"},{"title":"Create a secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json post /integration_secrets","href":"/api-reference/integration-secrets/create-a-secret"},{"title":"Delete an integration secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json delete /integration_secrets/{id}","href":"/api-reference/integration-secrets/delete-an-integration-secret"}]}]},{"group":"Video","pages":[{"title":"Getting Started with Video","sidebarTitle":"Getting Started","href":"/docs/video/get-started/index"},{"group":"SDKs","pages":[{"group":"JavaScript","pages":[{"title":"Getting Started with JavaScript SDK for Video","sidebarTitle":"Getting Started","href":"/docs/video/javascript-sdk/index"},{"title":"Room and Events","sidebarTitle":"Room and Events","href":"/docs/video/javascript-sdk/room-events/index"},{"title":"JavaScript Video Tutorial","sidebarTitle":"Tutorial","href":"/docs/video/javascript-sdk/javascript-video-tutorial/index"}]},{"title":"Getting Started with Android Client SDK","sidebarTitle":"Android SDK","href":"/docs/video/android-client-sdk/index"},{"title":"Getting Started with iOS Client SDK","sidebarTitle":"iOS SDK","href":"/docs/video/ios-client-sdk/index"}]},{"group":"Room Compositions API","pages":[{"title":"View a list of room compositions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_compositions","href":"/api-reference/room-compositions/view-a-list-of-room-compositions"},{"title":"Create a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_compositions","href":"/api-reference/room-compositions/create-a-room-composition"},{"title":"View a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_compositions/{room_composition_id}","href":"/api-reference/room-compositions/view-a-room-composition"},{"title":"Delete a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_compositions/{room_composition_id}","href":"/api-reference/room-compositions/delete-a-room-composition"}]},{"group":"Room Participants API","pages":[{"title":"View a list of room participants.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_participants","href":"/api-reference/room-participants/view-a-list-of-room-participants"},{"title":"View a room participant.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_participants/{room_participant_id}","href":"/api-reference/room-participants/view-a-room-participant"}]},{"group":"Room Recordings API","pages":[{"title":"View a list of room recordings.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_recordings","href":"/api-reference/room-recordings/view-a-list-of-room-recordings"},{"title":"Delete several room recordings in a bulk.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_recordings","href":"/api-reference/room-recordings/delete-several-room-recordings-in-a-bulk"},{"title":"View a room recording.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_recordings/{room_recording_id}","href":"/api-reference/room-recordings/view-a-room-recording"},{"title":"Delete a room recording.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_recordings/{room_recording_id}","href":"/api-reference/room-recordings/delete-a-room-recording"}]},{"group":"Room Sessions API","pages":[{"title":"View a list of room sessions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions","href":"/api-reference/room-sessions/view-a-list-of-room-sessions"},{"title":"View a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions/{room_session_id}","href":"/api-reference/room-sessions/view-a-room-session"},{"title":"End a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/end","href":"/api-reference/room-sessions/end-a-room-session"},{"title":"Kick participants from a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/kick","href":"/api-reference/room-sessions/kick-participants-from-a-room-session"},{"title":"Mute participants in room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/mute","href":"/api-reference/room-sessions/mute-participants-in-room-session"},{"title":"Unmute participants in room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/unmute","href":"/api-reference/room-sessions/unmute-participants-in-room-session"},{"title":"View a list of room participants.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions/{room_session_id}/participants","href":"/api-reference/room-sessions/view-a-list-of-room-participants"}]},{"group":"Rooms API","pages":[{"title":"View a list of rooms.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms","href":"/api-reference/rooms/view-a-list-of-rooms"},{"title":"Create a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms","href":"/api-reference/rooms/create-a-room"},{"title":"View a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms/{room_id}","href":"/api-reference/rooms/view-a-room"},{"title":"Update a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json patch /rooms/{room_id}","href":"/api-reference/rooms/update-a-room"},{"title":"Delete a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /rooms/{room_id}","href":"/api-reference/rooms/delete-a-room"},{"title":"View a list of room sessions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms/{room_id}/sessions","href":"/api-reference/rooms/view-a-list-of-room-sessions"}]},{"group":"Rooms Client Tokens API","pages":[{"title":"Create Client Token to join a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms/{room_id}/actions/generate_join_client_token","href":"/api-reference/rooms-client-tokens/create-client-token-to-join-a-room"},{"title":"Refresh Client Token to join a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms/{room_id}/actions/refresh_client_token","href":"/api-reference/rooms-client-tokens/refresh-client-token-to-join-a-room"}]}]},{"group":"SETI","pages":[{"title":"Retrieve Black Box Test Results","deprecated":null,"version":null,"openapi":"/openapi/source/external/seti/seti.json get /seti/black_box_test_results","href":"/api-reference/seti-observability/retrieve-black-box-test-results"}]},{"group":"Fax","pages":[{"title":"Getting Started with Telnyx Programmable Fax","sidebarTitle":"Getting Started","href":"/docs/programmable-fax/get-started/index"},{"title":"Quickstart Guide for Programmable Fax","sidebarTitle":"Quickstart","href":"/docs/programmable-fax/quickstart/index"},{"title":"Receiving Webhooks for Programmable Fax","sidebarTitle":"Receiving Webhooks","href":"/docs/programmable-fax/receiving-webhooks/index"},{"title":"Sending Commands","sidebarTitle":"Sending Commands","href":"/docs/programmable-fax/sending-commands/index"},{"title":"Send a Fax via API","sidebarTitle":"Send a fax via API","href":"/docs/programmable-fax/send-a-fax-api/index"},{"title":"Receive a Fax via API","sidebarTitle":"Receive a fax via API","href":"/docs/programmable-fax/receive-a-fax-api/index"},{"title":"Email to Fax","sidebarTitle":"Email to fax","href":"/docs/programmable-fax/email-to-fax/index"},{"group":"API Reference","pages":[{"group":"Programmable Fax Applications API","pages":[{"title":"List all Fax Applications","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /fax_applications","href":"/api-reference/programmable-fax-applications/list-all-fax-applications"},{"title":"Creates a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /fax_applications","href":"/api-reference/programmable-fax-applications/creates-a-fax-application"},{"title":"Deletes a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json delete /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/deletes-a-fax-application"},{"title":"Retrieve a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/retrieve-a-fax-application"},{"title":"Update a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json patch /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/update-a-fax-application"}]},{"group":"Programmable Fax Commands API","pages":[{"title":"View a list of faxes","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /faxes","href":"/api-reference/programmable-fax-commands/view-a-list-of-faxes"},{"title":"Send a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes","href":"/api-reference/programmable-fax-commands/send-a-fax"},{"title":"Delete a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json delete /faxes/{id}","href":"/api-reference/programmable-fax-commands/delete-a-fax"},{"title":"View a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /faxes/{id}","href":"/api-reference/programmable-fax-commands/view-a-fax"},{"title":"Cancel a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes/{id}/actions/cancel","href":"/api-reference/programmable-fax-commands/cancel-a-fax"},{"title":"Refresh a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes/{id}/actions/refresh","href":"/api-reference/programmable-fax-commands/refresh-a-fax"}]},{"group":"Callbacks API","pages":[{"title":"Fax delivered","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.delivered","href":"/api-reference/callbacks/fax-delivered"},{"title":"Fax failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.failed","href":"/api-reference/callbacks/fax-failed"},{"title":"Fax media processed","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.media.processed","href":"/api-reference/callbacks/fax-media-processed"},{"title":"Fax queued","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.queued","href":"/api-reference/callbacks/fax-queued"},{"title":"Fax sending started","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.sending.started","href":"/api-reference/callbacks/fax-sending-started"}]}]}]},{"group":"OAuth","pages":[{"group":"OAuth Discovery API","pages":[{"title":"Authorization server metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /.well-known/oauth-authorization-server","href":"/api-reference/oauth-discovery/authorization-server-metadata"},{"title":"Protected resource metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /.well-known/oauth-protected-resource","href":"/api-reference/oauth-discovery/protected-resource-metadata"}]},{"group":"OAuth Protocol API","pages":[{"title":"OAuth authorization endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/authorize","href":"/api-reference/oauth-protocol/oauth-authorization-endpoint"},{"title":"Get OAuth consent token","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/consent/{consent_token}","href":"/api-reference/oauth-protocol/get-oauth-consent-token"},{"title":"Token introspection","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/introspect","href":"/api-reference/oauth-protocol/token-introspection"},{"title":"JSON Web Key Set","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/jwks","href":"/api-reference/oauth-protocol/json-web-key-set"},{"title":"Dynamic client registration","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/register","href":"/api-reference/oauth-protocol/dynamic-client-registration"},{"title":"OAuth token endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/token","href":"/api-reference/oauth-protocol/oauth-token-endpoint"}]},{"group":"OAuth Clients API","pages":[{"title":"List OAuth clients","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/clients","href":"/api-reference/oauth-clients/list-oauth-clients"},{"title":"Create OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json post /oauth/clients","href":"/api-reference/oauth-clients/create-oauth-client"},{"title":"Delete OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json delete /oauth/clients/{id}","href":"/api-reference/oauth-clients/delete-oauth-client"},{"title":"Get OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/clients/{id}","href":"/api-reference/oauth-clients/get-oauth-client"},{"title":"Update OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json put /oauth/clients/{id}","href":"/api-reference/oauth-clients/update-oauth-client"}]},{"group":"OAuth Grants API","pages":[{"title":"List OAuth grants","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/grants","href":"/api-reference/oauth-grants/list-oauth-grants"},{"title":"Revoke OAuth grant","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json delete /oauth/grants/{id}","href":"/api-reference/oauth-grants/revoke-oauth-grant"},{"title":"Get OAuth grant","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/grants/{id}","href":"/api-reference/oauth-grants/get-oauth-grant"}]}]},{"group":"Bot Signup","pages":[{"group":"Bot Signup API","pages":[{"title":"Issue a bot challenge","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_challenge","href":"/api-reference/bot-signup/issue-a-bot-challenge"},{"title":"Register via bot signup","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_signup","href":"/api-reference/bot-signup/register-via-bot-signup"},{"title":"Resend a bot signup magic link","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_signup/resend_magic_link","href":"/api-reference/bot-signup/resend-a-bot-signup-magic-link"},{"title":"Exchange a magic link token for a session","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json get /bot_sessions","href":"/api-reference/bot-signup/exchange-a-magic-link-token-for-a-session"}]}]},{"group":"For AI Agents","pages":[{"title":"Other APIs llms.txt","sidebarTitle":"Other APIs llms txt","href":"/docs/development/llms/other-apis-llms-txt/index"},{"title":"Other APIs llms-full.txt","sidebarTitle":"Other APIs llms full txt","href":"/docs/development/llms/other-apis-llms-full-txt/index"}]}]}]},{"product":"Agent Platform","icon":"circle-nodes","pages":[{"title":"Agent Platform","href":"/docs/agent-platform"}]},{"product":"AI","icon":"microchip-ai","pages":[{"title":"AI","href":"/docs/inference/models"}]},{"product":"Voice","icon":"waveform","pages":[{"title":"Voice","href":"/docs/voice/overview"}]},{"product":"Compute","icon":"server","pages":[{"title":"Compute","href":"/docs/edge-compute/platform-overview"}]},{"product":"Storage","icon":"hard-drive","pages":[{"title":"Storage","href":"/docs/cloud-storage/overview"}]},{"product":"Virtual Private Cloud","icon":"cloud","pages":[{"title":"Virtual Private Cloud","href":"/docs/virtual-private-cloud"}]},{"product":"Calling","icon":"phone","pages":[{"title":"Calling","href":"/docs/voice/programmable-voice/voice-api-fundamentals"}]},{"product":"Messaging","icon":"message","pages":[{"title":"Messaging","href":"/docs/messaging/messages/send-message"}]},{"product":"Numbers","icon":"hashtag","pages":[{"title":"Numbers","href":"/docs/numbers/phone-numbers/getting-started"}]},{"product":"Wireless","icon":"broadcast-tower","pages":[{"title":"Wireless","href":"/docs/iot-sim/wireless-overview"}]}]},"basePath":"","title":"Update the current user profile (Beta) - Telnyx","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DIeMibn4.js","dist-DJnKvr0g.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2v50t8t.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","AssistantPageLink-BHrrjR1K.js"]}