This capability is in beta. Behavior can change before general availability.
Supply E.164 numbers unless ignoreE164Validation is enabled. scheduledAt must be 60 seconds to 30 days ahead.Selected-resource keys must supply agentId. Use Idempotency-Key to retry safely. Reusing it for different input returns idempotency_key_reuse.An identical replay returns the original result with Idempotent-Replayed: true. Organization call admission and concurrency limits still apply.
An API key (tars_sk_…) sent as Authorization: Bearer <key>. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Tars Docs","colors":{"primary":"#6D33AA","light":"#BFA3E6","dark":"#4A1F75"},"logo":{"light":"https://mintcdn.com/tars-c52ebe98/rUEfkErNVm3dhz_l/logo/tars.png?fit=max\u0026auto=format\u0026n=rUEfkErNVm3dhz_l\u0026q=85\u0026s=890c9970e6f22a96e9872dcfafd97c99","dark":"https://mintcdn.com/tars-c52ebe98/rUEfkErNVm3dhz_l/logo/tars.png?fit=max\u0026auto=format\u0026n=rUEfkErNVm3dhz_l\u0026q=85\u0026s=890c9970e6f22a96e9872dcfafd97c99"},"favicon":"https://mintcdn.com/tars-c52ebe98/rUEfkErNVm3dhz_l/logo/favicon.svg?fit=max\u0026auto=format\u0026n=rUEfkErNVm3dhz_l\u0026q=85\u0026s=52db0ae88fc456bf81754a5f78889caf","api":{"openapi":["api-reference/openapi.json"],"playground":{"display":"interactive"}},"background":{"decoration":"grid","color":{"light":"#F5F5F5","dark":"#1A1A1A"}},"navbar":{"primary":{"type":"button","label":"Log in","href":"https://dashboard.hellotars.com"}},"footer":{"socials":{"x":"https://x.com/hellotars_ai","linkedin":"https://www.linkedin.com/company/tars","instagram":"https://www.instagram.com/hellotars","youtube":"https://youtube.com/@hellotars"}},"seo":{"indexing":"all"},"fonts":{"family":"Poppins"},"interaction":{"drilldown":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tars-c52ebe98","hasAudioNarration":false,"actualSubdomain":"tars-c52ebe98","customDomains":["hellotars.com"],"gitSource":{"type":"github","owner":"tars-technologies","repo":"tars-monorepo","deployBranch":"production","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad9d4c7383567486ff70730","collectionId":"1090b60d-faf4-4958-ab94-f4ff6a4dd23a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad9d4c7383567486ff70730"},"entitlements":{},"buildId":"6ad9d4c7383567486ff70730","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Get started","count":147},{"language":"default","tag":"Guides","count":88},{"language":"default","tag":"Developer","count":52},{"language":"default","tag":"APIs","count":33},{"language":"default","tag":"Building agents","count":29},{"language":"default","tag":"Gambit mastery","count":19},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"Calls","count":9},{"language":"default","tag":"Campaigns","count":9},{"language":"default","tag":"Deploy \u0026 channels","count":8}]},"assistantConfig":{"enableStarterQuestions":false},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"@keyframes tars-travel{0%{left:10%;opacity:0}10%,85%{opacity:.95}to{left:calc(90% - 72px);opacity:0}}@keyframes tars-halo{0%{transform:scale(.85);opacity:.9}70%,to{transform:scale(1.35);opacity:0}}@keyframes tars-sheen{0%{left:-60%;opacity:0}25%{opacity:1}to{left:115%;opacity:0}}@keyframes tars-rise{0%{opacity:0;transform:translateY(10px)}to{opacity:1;transform:translateY(0)}}*{scrollbar-width:none;scrollbar-color:rgba(190,164,196,.27) transparent}::-webkit-scrollbar{width:none}::-webkit-scrollbar-track{background:0 0}::-webkit-scrollbar-thumb{background-color:rgba(156,163,175,.5)}::-webkit-scrollbar-thumb:hover{background-color:rgba(156,163,175,.7)}th{text-align:left;font-weight:600;border-bottom:2px dotted rgba(156,163,175,.7)}td:first-child,th:first-child{font-weight:500;text-wrap:nowrap;border-right:2px dotted rgba(156,163,175,.7)}.chat-assistant-floating-input,:has(>.chat-assistant-floating-input){display:none!important}.tars-browser{--tars-browser-chrome:#e8e4ee;--tars-browser-border:rgba(109, 51, 170, 0.18);--tars-browser-url:#6b6474;border:1px solid var(--tars-browser-border);border-radius:12px;overflow:hidden;margin:1.25rem 0;box-shadow:0 12px 32px -12px rgba(24,12,40,.35)}.dark .tars-browser{--tars-browser-chrome:#2a2432;--tars-browser-border:rgba(190, 164, 196, 0.22);--tars-browser-url:#a79fb3}.tars-browser-bar{display:flex;align-items:center;gap:.75rem;padding:.55rem .85rem;background:var(--tars-browser-chrome);border-bottom:1px solid var(--tars-browser-border)}.tars-browser-dots{display:flex;gap:.4rem;flex:none}.tars-browser-dots i{width:11px;height:11px;border-radius:50%;background:#ff5f57}.tars-browser-dots i:nth-child(2){background:#febc2e}.tars-browser-dots i:nth-child(3){background:#28c840}.tars-browser-url{font-size:.75rem;color:var(--tars-browser-url);font-family:ui-monospace,SFMono-Regular,Menlo,monospace;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.tars-browser-view img{display:block;width:100%;margin:0;border-radius:0}@media (min-width:1280px){main#content-container{padding-left:1.5rem;padding-right:1.5rem}main#content-container .flex.flex-row-reverse{padding-left:1.5rem}main#content-container div[class*=max-w-xl]{max-width:60rem}}.tars-rail{position:relative;display:grid;grid-template-columns:repeat(5,minmax(0,1fr));gap:.75rem;margin:1.75rem 0 2.25rem;padding-top:.35rem}.tars-rail::after,.tars-rail::before{content:\"\";position:absolute;z-index:0;left:10%}.tars-rail::before{top:24px;right:10%;height:2px;border-radius:2px;background:repeating-linear-gradient(90deg,rgba(109,51,170,.28) 0 7px,rgba(109,51,170,0) 7px 14px)}.dark .tars-rail::before{background:repeating-linear-gradient(90deg,rgba(191,163,230,.35) 0 7px,rgba(191,163,230,0) 7px 14px)}.tars-rail::after{top:21px;width:72px;height:8px;border-radius:999px;background:linear-gradient(90deg,rgba(191,163,230,0),#6d33aa 45%,rgba(191,163,230,0));filter:blur(1.5px);animation:tars-travel 5s cubic-bezier(.65,0,.35,1) infinite}.tars-rail-stage{position:relative;z-index:1;text-align:center;animation:tars-rise .5s ease both}.tars-rail-stage:nth-child(2){animation-delay:.08s}.tars-rail-stage:nth-child(3){animation-delay:.16s}.tars-rail-stage:nth-child(4){animation-delay:.24s}.tars-rail-stage:nth-child(5){animation-delay:.32s}.tars-rail-dot{position:relative;z-index:1;width:40px;height:40px;margin:0 auto .6rem;border-radius:50%;display:flex;align-items:center;justify-content:center;color:#fff;background:linear-gradient(140deg,#6d33aa,#bfa3e6);box-shadow:0 8px 18px -8px rgba(109,51,170,.85)}.tars-rail-dot::before{content:\"\";position:absolute;inset:-5px;border-radius:50%;border:2px solid rgba(109,51,170,.35);animation:tars-halo 3.2s ease-out infinite}.tars-rail-stage:nth-child(2) .tars-rail-dot::before{animation-delay:.6s}.tars-rail-stage:nth-child(3) .tars-rail-dot::before{animation-delay:1.2s}.tars-rail-stage:nth-child(4) .tars-rail-dot::before{animation-delay:1.8s}.tars-rail-stage:nth-child(5) .tars-rail-dot::before{animation-delay:2.4s}.tars-rail-name{font-size:.82rem;font-weight:600;letter-spacing:.01em}.tars-rail-note{font-size:.74rem;line-height:1.35;margin-top:.15rem;color:rgba(60,50,75,.72)}.dark .tars-rail-note{color:rgba(214,206,224,.7)}.tars-caps{display:grid;grid-template-columns:repeat(auto-fit,minmax(215px,1fr));gap:.85rem;margin:1.5rem 0 2rem}.tars-cap{position:relative;overflow:hidden;display:block;padding:.95rem 1rem 1.05rem;border-radius:14px;border:1px solid rgba(109,51,170,.16);background:linear-gradient(158deg,rgba(191,163,230,.13),rgba(191,163,230,0));text-decoration:none;color:inherit;animation:tars-rise .55s ease both;transition:transform .25s ease,box-shadow .25s ease,border-color .25s ease}.dark .tars-cap{border-color:rgba(191,163,230,.18);background:linear-gradient(158deg,rgba(191,163,230,.09),rgba(191,163,230,0))}.tars-cap:nth-child(3n+2){animation-delay:.06s}.tars-cap:nth-child(3n){animation-delay:.12s}.tars-cap::after{content:\"\";position:absolute;top:0;bottom:0;left:-60%;width:45%;background:linear-gradient(100deg,rgba(255,255,255,0),rgba(255,255,255,.35),rgba(255,255,255,0));opacity:0;transform:skewX(-14deg);pointer-events:none}.dark .tars-cap::after{background:linear-gradient(100deg,rgba(191,163,230,0),rgba(191,163,230,.16),rgba(191,163,230,0))}.tars-cap:hover{transform:translateY(-4px);border-color:rgba(109,51,170,.45);box-shadow:0 18px 32px -20px rgba(24,12,40,.7)}.tars-cap:hover::after{animation:tars-sheen .85s ease forwards}.tars-cap-head,.tars-cap-icon{display:flex;align-items:center}.tars-cap-head{gap:.55rem;margin-bottom:.4rem}.tars-cap-icon{flex:none;width:30px;height:30px;border-radius:9px;justify-content:center;color:#fff;background:linear-gradient(140deg,#6d33aa,#9a63d4);transition:transform .25s ease}.tars-cap:hover .tars-cap-icon{transform:rotate(-6deg) scale(1.08)}.tars-cap .tars-cap-title{font-size:.92rem;font-weight:600;line-height:1.25}.tars-cap .tars-cap-text{font-size:.83rem;font-weight:400;line-height:1.45;margin:0;color:rgba(60,50,75,.78)}.dark .tars-cap .tars-cap-text{color:rgba(214,206,224,.75)}@media (max-width:900px){.tars-caps{grid-template-columns:repeat(2,minmax(0,1fr))}.tars-rail{grid-template-columns:repeat(3,minmax(0,1fr));row-gap:1.25rem}.tars-rail::after,.tars-rail::before{display:none}}.tars-plans{display:grid;grid-template-columns:repeat(3,minmax(0,1fr));gap:.85rem;margin:1.5rem 0 2rem;align-items:start}.tars-plan{position:relative;padding:1.05rem 1.1rem 1.15rem;border-radius:14px;border:1px solid rgba(109,51,170,.16);background:linear-gradient(158deg,rgba(191,163,230,.13),rgba(191,163,230,0));animation:tars-rise .55s ease both}.tars-plan:nth-child(2){animation-delay:.06s}.tars-plan:nth-child(3){animation-delay:.12s}.dark .tars-plan{border-color:rgba(191,163,230,.18);background:linear-gradient(158deg,rgba(191,163,230,.09),rgba(191,163,230,0))}.tars-plan--pick{border-color:rgba(109,51,170,.5);box-shadow:0 16px 30px -22px rgba(24,12,40,.75)}.dark .tars-plan--pick{border-color:rgba(191,163,230,.5)}.tars-plan-points li::before,.tars-plan-tag{position:absolute;background:linear-gradient(140deg,#6d33aa,#9a63d4)}.tars-plan-tag{top:-.6rem;right:.9rem;padding:.12rem .5rem;border-radius:999px;font-size:.66rem;font-weight:600;letter-spacing:.03em;text-transform:uppercase;color:#fff}.tars-plan-name{font-size:1rem;font-weight:600;line-height:1.2}.tars-plan-for{font-size:.8rem;line-height:1.4;margin-top:.15rem;color:rgba(60,50,75,.72)}.dark .tars-plan-for{color:rgba(214,206,224,.7)}.tars-plan-points{list-style:none;margin:.75rem 0 0;padding:0;display:grid;gap:.32rem}.tars-plan-points li{position:relative;padding-left:1.05rem;font-size:.82rem;line-height:1.4}.tars-plan-points li::before{content:\"\";left:0;top:.48em;width:6px;height:6px;border-radius:50%}.tars-matrix{overflow-x:auto;margin:1.35rem 0 .75rem;border-radius:12px;border:1px solid rgba(109,51,170,.16)}.dark .tars-matrix{border-color:rgba(191,163,230,.18)}.tars-matrix table{display:table;width:100%;min-width:520px;border-collapse:collapse;font-size:.83rem;margin:0}.tars-matrix td,.tars-matrix th{padding:.55rem .8rem;text-align:left;border-bottom:1px solid rgba(109,51,170,.1)}.dark .tars-matrix td,.dark .tars-matrix th{border-bottom-color:rgba(191,163,230,.12)}.tars-matrix tr:last-child td{border-bottom:0}.tars-matrix thead th{font-weight:600;background:rgba(191,163,230,.14)}.dark .tars-matrix thead th{background:rgba(191,163,230,.08)}.tars-matrix td:not(:first-child),.tars-matrix th:not(:first-child){text-align:center;width:17%}.tars-matrix .tars-col-pick{background:rgba(191,163,230,.09)}.dark .tars-matrix .tars-col-pick{background:rgba(191,163,230,.06)}.tars-yes{color:#6d33aa;font-weight:700}.dark .tars-yes{color:#c6a6ec}.tars-no{color:rgba(60,50,75,.4)}.dark .tars-no{color:rgba(214,206,224,.35)}@media (max-width:720px){.tars-plans{grid-template-columns:minmax(0,1fr)}.tars-plan-tag{top:.75rem}}@media (max-width:560px){.tars-caps{grid-template-columns:minmax(0,1fr)}.tars-rail{grid-template-columns:repeat(2,minmax(0,1fr))}}@media (prefers-reduced-motion:reduce){.tars-cap,.tars-cap::after,.tars-plan,.tars-rail-dot::before,.tars-rail-stage,.tars-rail::after{animation:none!important}.tars-cap,.tars-cap-icon{transition:none}}select{color-scheme:light;border-radius:6px}select option{background-color:#fff;color:#2a2432;padding:.35rem .5rem}select option:checked,select option:hover{background-color:rgba(109,51,170,.14);color:#4a2278}.dark select{color-scheme:dark}.dark select option{background-color:#2a2432;color:#e9e4f0}.dark select option:checked,.dark select option:hover{background-color:rgba(191,163,230,.22);color:#f3eefa}"}],"page":{"pagePath":"developer/api/calls/create","slug":"/developer/api/calls/create","pageMetadata":{"title":"Place or schedule a call","icon":"code","description":"Place a phone call now or schedule it with an idempotent request.","mode":"reference","availability":"beta","covers":["3.4"],"last_reviewed":"2026-10-20T00:00:00.000Z","openapi":"api-reference/openapi.json POST /api/v1/calls","href":"/developer/api/calls/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Place a phone call now or schedule it with an idempotent request.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Info}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`This capability is in `,_jsx(_components.strong,{children:`beta`}),`. Behavior can change before general availability.`]})}),`\n`,_jsx(_components.p,{children:`Supply E.164 numbers unless ignoreE164Validation is enabled. scheduledAt must be 60 seconds to 30 days ahead.`}),`\n`,_jsx(_components.p,{children:`Selected-resource keys must supply agentId. Use Idempotency-Key to retry safely. Reusing it for different input returns idempotency_key_reuse.`}),`\n`,_jsx(_components.p,{children:`An identical replay returns the original result with Idempotent-Replayed: true. Organization call admission and concurrency limits still apply.`}),`\n`,_jsx(Heading,{level:`2`,id:`related-pages`,children:`Related pages`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/developer/authentication`,children:`Authentication`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Place or schedule a call","icon":"code","description":"Place a phone call now or schedule it with an idempotent request.","mode":"reference","availability":"beta","covers":["3.4"],"last_reviewed":"2026-10-20T00:00:00.000Z","openapi":"api-reference/openapi.json POST /api/v1/calls","href":"/developer/api/calls/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Related pages","slug":"related-pages","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tars-c52ebe98/f779323b07fa65a8/custom.js"],"openApiReferenceData":{"operation":{"operationId":"placeCall","summary":"Place or schedule a phone call","description":"Place a phone call now or schedule it with an idempotent request.","tags":["Calls"],"security":["c1c60379-3cdf-4677-a282-641c791e1eb0"],"x-tars-permission":"calls:write","x-tars-rate-class":"call_create","parameters":["4c7eef80-4fd8-43ad-bfb9-32f53bde60e1"],"requestBody":"35274a4e-b4e5-40d0-b121-f30163ec9d00","responses":{"201":"f9d5c5f9-68ce-434f-aac4-e881a5247d0e","202":"3d27e667-a02a-444f-8bb5-04d6f90b2c6e","400":"4b85429d-6edb-4c38-bf0f-6b86a838abf8","401":"44e5d4d8-3b1a-45bc-9881-189f5ab358f0","403":"63b5549c-6052-4b21-b908-3af5979b14de","404":"f89301a6-42cc-4782-b35a-e6cd343246df","405":"1f52e89b-bf86-40c6-9ca2-011ee91d723d","409":"612a5b61-3118-4dcc-8edc-37e638b901ac","413":"60f704d7-1e4d-4499-b400-569e1bba5d4a","429":"4c6a6237-f56b-4e7a-99c6-4396370bede1","500":"efe3c5cf-b136-4ca8-9e26-9f70bf5eb4c7","503":"19b45e3a-4b95-4a6a-b284-c76eb7534ce6"},"method":"post","type":"path","servers":["ec47622e-3050-4d86-b2ac-ad3070f32e21","686a35bc-5ad5-4220-8151-a91000cafb50","d5b88e62-673d-4fa8-8340-72ac7715a29e","93278891-e431-4bbf-803d-87b1e6c414af"],"path":"/api/v1/calls","baseUrlOptions":["https://us.api.hellotars.com","https://eu.api.hellotars.com","https://in.api.hellotars.com","https://qa.api.hellotars.com"],"title":"Place or schedule a phone call","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4c7eef80-4fd8-43ad-bfb9-32f53bde60e1":{"name":"Idempotency-Key","in":"header","required":false,"description":"Replays the original answer for 24 hours. The same key with another body returns idempotency_key_reuse.","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"Replays the original answer for 24 hours. The same key with another body returns idempotency_key_reuse.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Place or schedule a phone call.","additionalProperties":false,"properties":{"fromNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","isRequired":true,"uniqueKey":"fromNumber","typeLabel":"string"},"toNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","isRequired":true,"uniqueKey":"toNumber","typeLabel":"string"},"agentId":{"type":"string","maxLength":128,"description":"The voice agent id. Required when the key is limited to selected resources.","uniqueKey":"agentId","typeLabel":"string"},"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"variables.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"variables.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"variables.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"variables","typeLabel":"object"},"metadata":{"type":"object","description":"At most 16 KB.","uniqueKey":"metadata","typeLabel":"object"},"customSipHeaders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"customSipHeaders.additionalProperties","typeLabel":"string"},"uniqueKey":"customSipHeaders","typeLabel":"object"},"ignoreE164Validation":{"type":"boolean","default":false,"description":"Skip E.164 validation of fromNumber and toNumber to dial internal numbers on an imported SIP trunk.","uniqueKey":"ignoreE164Validation","typeLabel":"boolean"},"destinationTimezone":{"oneOf":[{"type":"string","description":"IANA timezone of the recipient, used for the calling-hours check when the contact has none.","uniqueKey":"destinationTimezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA timezone of the recipient, used for the calling-hours check when the contact has none.","uniqueKey":"destinationTimezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"destinationTimezone","typeLabel":"string | null"},"scheduledAt":{"oneOf":[{"type":"integer","description":"When to place the call, in milliseconds, between 60 seconds and 30 days ahead.","uniqueKey":"scheduledAt.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When to place the call, in milliseconds, between 60 seconds and 30 days ahead.","uniqueKey":"scheduledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduledAt","typeLabel":"integer | null"},"language":{"oneOf":[{"type":"string","description":"Locale for this call only, for example es-419. It must be one of the agent's languages.","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locale for this call only, for example es-419. It must be one of the agent's languages.","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"}},"required":["fromNumber","toNumber"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"fromNumber":"\u003cstring>","toNumber":"\u003cstring>","agentId":"\u003cstring>","variables":{},"metadata":{},"customSipHeaders":{},"ignoreE164Validation":false,"destinationTimezone":"\u003cstring>","scheduledAt":123,"language":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f9d5c5f9-68ce-434f-aac4-e881a5247d0e":{"description":"The call was placed.","headers":{"Idempotent-Replayed":{"description":"true when this is the replayed original answer.","schema":{"const":"true"}}},"content":{"application/json":{"schema":{"type":"object","description":"The call was registered and is being dialled.","properties":{"callId":{"type":"string","isRequired":true,"uniqueKey":"callId","typeLabel":"string"},"status":{"const":"registered","isRequired":true,"uniqueKey":"status","typeLabel":"any"},"scheduled":{"const":false,"isRequired":true,"uniqueKey":"scheduled","typeLabel":"any"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"const":"variable_coerced","isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"any"},"path":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"}},"required":["code","path"],"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"}},"required":["callId","status","scheduled"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"callId":"\u003cstring>","status":"registered","scheduled":false,"warnings":[{"code":"variable_coerced","path":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3d27e667-a02a-444f-8bb5-04d6f90b2c6e":{"description":"The call was scheduled.","headers":{"Idempotent-Replayed":{"description":"true when this is the replayed original answer.","schema":{"const":"true"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"scheduledCallId":{"type":"string","description":"A voiceScheduledCalls id.","isRequired":true,"uniqueKey":"scheduledCallId","typeLabel":"string"},"scheduled":{"const":null,"isRequired":true,"uniqueKey":"scheduled","typeLabel":"any"},"scheduledAt":{"type":"number","isRequired":true,"uniqueKey":"scheduledAt","typeLabel":"number"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"const":"variable_coerced","isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"any"},"path":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"}},"required":["code","path"],"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"}},"required":["scheduledCallId","scheduled","scheduledAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"scheduledCallId":"\u003cstring>","scheduled":null,"scheduledAt":123,"warnings":[{"code":"variable_coerced","path":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4b85429d-6edb-4c38-bf0f-6b86a838abf8":{"description":"validation_failed, invalid_json, variable_key_not_allowed, invalid_variable_value","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"44e5d4d8-3b1a-45bc-9881-189f5ab358f0":{"description":"unauthorized, invalid_key","headers":{"WWW-Authenticate":{"schema":{"const":"Bearer"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"63b5549c-6052-4b21-b908-3af5979b14de":{"description":"organization_inactive, billing_locked, permission_missing, resource_not_allowed, entitlement_missing","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f89301a6-42cc-4782-b35a-e6cd343246df":{"description":"not_found","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1f52e89b-bf86-40c6-9ca2-011ee91d723d":{"description":"method_not_allowed","headers":{"Allow":{"description":"The methods this path accepts.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"612a5b61-3118-4dcc-8edc-37e638b901ac":{"description":"wrong_region, idempotency_key_reuse, agent_unavailable, invalid_state","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"60f704d7-1e4d-4499-b400-569e1bba5d4a":{"description":"payload_too_large","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4c6a6237-f56b-4e7a-99c6-4396370bede1":{"description":"rate_limited, concurrency_limit_reached, worker_busy","headers":{"Retry-After":{"description":"Whole seconds to wait before retrying.","schema":{"type":"integer","minimum":1}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"efe3c5cf-b136-4ca8-9e26-9f70bf5eb4c7":{"description":"internal_error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"19b45e3a-4b95-4a6a-b284-c76eb7534ce6":{"description":"worker_not_deployed, worker_unavailable","headers":{"Retry-After":{"description":"Whole seconds to wait before retrying.","schema":{"type":"integer","minimum":1}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. Clients switch on code, never on title or detail.","properties":{"title":{"type":"string","description":"The catalogue title of code.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"A sentence about this failure, for a developer.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"The request id (req_…). Quote it when you contact support.","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","enum":["invalid_json","validation_failed","variable_key_not_allowed","invalid_variable_value","cursor_expired","cursor_mismatch","campaign_mode_invalid","unauthorized","invalid_key","session_invalid","insufficient_balance","organization_inactive","billing_locked","permission_missing","resource_not_allowed","entitlement_missing","origin_not_allowed","recaptcha_failed","consent_revoked","us_marketing_blocked","channel_test_mode","quota_exceeded","forbidden","not_found","method_not_allowed","wrong_region","conflict","contact_exists","idempotency_key_reuse","agent_unavailable","call_not_live","call_still_live","call_content_deleted","invalid_state","campaign_paused","template_version_drift","channel_unavailable","artefact_deleted","campaign_gone","payload_too_large","template_not_approved","channel_misconfigured","channel_reauth_required","meta_rejected","rate_limited","concurrency_limit_reached","worker_busy","meta_rate_limited","internal_error","upstream_unavailable","meta_unavailable","worker_not_deployed","worker_unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"true when the same request can succeed later.","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"One field that failed validation.","properties":{"path":{"type":"string","description":"Dotted path of the field (template.parameters.body.0), the query parameter name, or an empty string for the whole body.","isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"code":{"type":"string","description":"Why the field failed, for example required, unknown_field, out_of_range or template_param_missing.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["path","code"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"required":{"type":"string","description":"The permission the key lacks (permission_missing).","uniqueKey":"required","typeLabel":"string"},"region":{"type":"string","description":"The organization's region (wrong_region).","uniqueKey":"region","typeLabel":"string"},"field":{"type":"string","enum":["email","phone"],"uniqueKey":"field","typeLabel":"enum\u003cstring>"},"contactId":{"type":"string","description":"The contact that already has the email or phone.","uniqueKey":"contactId","typeLabel":"string"},"callId":{"type":"string","uniqueKey":"callId","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"}},"required":["title","status","detail","instance","code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"invalid_json","retryable":true,"errors":[{"path":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}],"required":"\u003cstring>","region":"\u003cstring>","field":"email","contactId":"\u003cstring>","callId":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c1c60379-3cdf-4677-a282-641c791e1eb0":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (`tars_sk_…`) sent as `Authorization: Bearer \u003ckey>`. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ec47622e-3050-4d86-b2ac-ad3070f32e21":{"url":"https://us.api.hellotars.com","description":"United States"},"686a35bc-5ad5-4220-8151-a91000cafb50":{"url":"https://eu.api.hellotars.com","description":"European Union"},"d5b88e62-673d-4fa8-8340-72ac7715a29e":{"url":"https://in.api.hellotars.com","description":"India"},"93278891-e431-4bbf-803d-87b1e6c414af":{"url":"https://qa.api.hellotars.com","description":"Qatar"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key (`tars_sk_…`) sent as `Authorization: Bearer \u003ckey>`. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key (`tars_sk_…`) sent as `Authorization: Bearer \u003ckey>`. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"tars-c52ebe98","siteName":"Tars Docs","title":"Place or schedule a call - Tars Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T09:18:38.580Z","originalFileLocation":"developer/api/calls/create.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=\"Place a phone call now or schedule it with an idempotent request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tars Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_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=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Place or schedule a call - Tars Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Place a phone call now or schedule it with an idempotent request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tars Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://hellotars.com/docs/developer/api/calls/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tars-c52ebe98.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Place+or+schedule+a+call\u0026amp;description=Place+a+phone+call+now+or+schedule+it+with+an+idempotent+request.\u0026amp;theme=e8531eb84546bba23813684d\u0026amp;signature=ac2dc926ef0dd088863a58742ecbfe3e894f3677fcf5514c8adf600408a1f238\">\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=\"Place or schedule a call - Tars Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Place a phone call now or schedule it with an idempotent request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tars-c52ebe98.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Place+or+schedule+a+call\u0026amp;description=Place+a+phone+call+now+or+schedule+it+with+an+idempotent+request.\u0026amp;theme=e8531eb84546bba23813684d\u0026amp;signature=ac2dc926ef0dd088863a58742ecbfe3e894f3677fcf5514c8adf600408a1f238\">\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=\"/docs/mintlify-assets/_mintlify/favicons/tars-c52ebe98/ToOJri8sW6lRr17z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tars Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6D33AA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://hellotars.com/docs/developer/api/calls/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/developer/api/calls/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hellotars.com/#organization\",\"name\":\"Tars Docs\",\"url\":\"https://hellotars.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tars-c52ebe98/rUEfkErNVm3dhz_l/logo/tars.png?fit=max\u0026auto=format\u0026n=rUEfkErNVm3dhz_l\u0026q=85\u0026s=890c9970e6f22a96e9872dcfafd97c99\"}},{\"@type\":\"WebSite\",\"@id\":\"https://hellotars.com/docs#website\",\"name\":\"Tars Docs\",\"url\":\"https://hellotars.com/docs\",\"publisher\":{\"@id\":\"https://hellotars.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://hellotars.com/docs/developer/api/calls/create#webpage\",\"url\":\"https://hellotars.com/docs/developer/api/calls/create\",\"name\":\"Place or schedule a call\",\"description\":\"Place a phone call now or schedule it with an idempotent request.\",\"dateModified\":\"2026-10-22T09:18:38.580Z\",\"isPartOf\":{\"@id\":\"https://hellotars.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://hellotars.com/docs/developer/api/calls/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://hellotars.com/docs/developer/api/calls/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developer\",\"item\":\"https://hellotars.com/docs/developer/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"APIs\",\"item\":\"https://hellotars.com/docs/developer/api/conversations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Calls\",\"item\":\"https://hellotars.com/docs/developer/api/calls\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Place or schedule a call\",\"item\":\"https://hellotars.com/docs/developer/api/calls/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://hellotars.com/docs/developer/api/calls/create#apireference\",\"headline\":\"Place or schedule a call\",\"name\":\"Place or schedule a call\",\"description\":\"Place a phone call now or schedule it with an idempotent request.\",\"url\":\"https://hellotars.com/docs/developer/api/calls/create\",\"mainEntityOfPage\":{\"@id\":\"https://hellotars.com/docs/developer/api/calls/create#webpage\"},\"dateModified\":\"2026-10-22T09:18:38.580Z\",\"publisher\":{\"@id\":\"https://hellotars.com/#organization\"},\"isPartOf\":{\"@id\":\"https://hellotars.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tars Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tars Docs","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","groups":[{"group":"Welcome","icon":"hand-wave","pages":[{"title":"Welcome to Tars","sidebarTitle":"Introduction","icon":"house","mode":"concept","href":""},{"title":"What is Tars?","icon":"circle-question","mode":"concept","href":"/get-started/what-is-tars"},{"title":"Quickstart: build your first agent","icon":"rocket","mode":"tutorial","href":"/get-started/quickstart"}]},{"group":"Core concepts","icon":"lightbulb","pages":[{"title":"Organizations and members","icon":"building","mode":"concept","href":"/get-started/organizations-and-members"},{"title":"Agents, flows, and deployments","icon":"diagram-project","mode":"concept","href":"/get-started/agents-flows-deployments"},{"title":"Plans overview","icon":"credit-card","mode":"concept","href":"/get-started/plans-overview"},{"title":"Invite your team","icon":"user-plus","mode":"how-to","href":"/get-started/invite-your-team"}]},{"group":"Guides","icon":"book","pages":[{"group":"Building agents","icon":"hammer","expanded":false,"pages":[{"title":"Create an agent","icon":"plus","mode":"how-to","href":"/guides/building/create-an-agent"},{"title":"Builder basics","icon":"diagram-project","mode":"how-to","href":"/guides/building/builder-basics"},{"group":"Gambit mastery","icon":"cube","pages":[{"title":"Gambit mastery","sidebarTitle":"Overview","icon":"compass","mode":"reference","href":"/guides/building/gambits/overview"},{"title":"AI Agent gambit","icon":"wand-magic-sparkles","mode":"concept","href":"/guides/building/gambits/ai-agent"},{"title":"Text gambit","icon":"input-text","mode":"reference","href":"/guides/building/gambits/text"},{"title":"Button gambit","icon":"square-check","mode":"reference","href":"/guides/building/gambits/button"},{"title":"Card gambit","icon":"address-card","mode":"reference","href":"/guides/building/gambits/card"},{"title":"Star Rating gambit","icon":"star","mode":"reference","href":"/guides/building/gambits/star-rating"},{"title":"Date \u0026 Time gambit","icon":"calendar-days","mode":"reference","href":"/guides/building/gambits/date-time"},{"title":"Media Upload gambit","icon":"arrow-up-from-bracket","mode":"reference","href":"/guides/building/gambits/media-upload"},{"title":"Geo Location gambit","icon":"location-dot","mode":"reference","href":"/guides/building/gambits/geo-location"},{"title":"Auto Suggestion gambit","icon":"list-check","mode":"reference","href":"/guides/building/gambits/auto-suggestion"},{"title":"Start and End gambits","icon":"flag-checkered","mode":"reference","href":"/guides/building/gambits/start-and-end"},{"title":"No Input gambit","icon":"forward","mode":"reference","href":"/guides/building/gambits/no-input"},{"title":"Redirect gambit","icon":"arrow-up-right-from-square","mode":"reference","href":"/guides/building/gambits/redirect"},{"title":"Language gambit","icon":"language","mode":"reference","href":"/guides/building/gambits/language"},{"title":"API Call gambit","icon":"code","mode":"reference","href":"/guides/building/gambits/api-call"},{"title":"Custom Code gambit","icon":"brackets-curly","mode":"reference","href":"/guides/building/gambits/custom-code"},{"title":"Channel gambit","icon":"paper-plane","mode":"reference","href":"/guides/building/gambits/channel"},{"title":"Trigger gambit","icon":"bolt","mode":"reference","href":"/guides/building/gambits/trigger"},{"title":"Live Chat gambit","icon":"headset","mode":"reference","href":"/guides/building/gambits/live-chat"}]},{"group":"Flow and inputs","icon":"shuffle","pages":[{"title":"Use variables","icon":"dollar-sign","mode":"how-to","href":"/guides/building/variables"},{"title":"Flow control and branching","icon":"code-fork","mode":"how-to","href":"/guides/building/flow-control-and-branching"},{"title":"Build a multi-language agent","icon":"language","mode":"how-to","href":"/guides/building/languages"}]},{"group":"Publish with confidence","icon":"badge-check","pages":[{"title":"Test your agent","icon":"flask","mode":"how-to","href":"/guides/building/testing-your-agent"},{"title":"Drafts and publishing","icon":"code-branch","mode":"concept","href":"/guides/building/drafts-and-publishing"},{"title":"Guardrails and safety","icon":"shield-halved","mode":"concept","href":"/guides/building/guardrails-and-safety"}]},{"title":"Built-in AI capabilities","icon":"sparkles","mode":"concept","href":"/guides/building/built-in-ai-capabilities"},{"title":"Set up agent email notifications","icon":"bell","mode":"how-to","href":"/guides/building/agent-email-notifications"}]},{"group":"Knowledge","icon":"book-open-cover","expanded":false,"pages":[{"title":"Create a knowledge base","icon":"plus","mode":"how-to","href":"/guides/knowledge/create-a-knowledge-base"},{"title":"Import a website","icon":"globe","mode":"how-to","href":"/guides/knowledge/import-a-website"},{"title":"Manage documents","icon":"file-lines","mode":"how-to","href":"/guides/knowledge/manage-documents"},{"group":"Retrievers","icon":"magnifying-glass","pages":[{"title":"Retrievers explained","sidebarTitle":"How retrievers work","icon":"circle-question","mode":"concept","href":"/guides/knowledge/retrievers-explained"},{"title":"Configure a retriever","icon":"sliders","mode":"how-to","href":"/guides/knowledge/configure-a-retriever"},{"title":"Measure retrieval quality","icon":"flask","mode":"how-to","href":"/guides/knowledge/measure-retrieval-quality"},{"title":"Attach knowledge to an agent","icon":"link","mode":"how-to","href":"/guides/knowledge/attach-knowledge-to-an-agent"}]}]},{"group":"Tools \u0026 CodeKit","icon":"plug","expanded":false,"pages":[{"title":"Connect a toolkit","icon":"link","mode":"how-to","href":"/guides/tools/connect-a-toolkit"},{"title":"Enable and use actions","icon":"toggle-on","mode":"how-to","href":"/guides/tools/enable-and-use-actions"},{"title":"CodeKit overview","icon":"code","mode":"concept","href":"/guides/tools/codekit-overview"},{"title":"Write a custom action","icon":"pen-to-square","mode":"how-to","href":"/guides/tools/write-a-custom-action"}]},{"group":"Deploy \u0026 channels","icon":"share-nodes","expanded":false,"pages":[{"title":"Deployments explained","icon":"rocket","mode":"concept","href":"/guides/deploy/deployments-explained"},{"title":"Share your agent link","icon":"link","mode":"how-to","href":"/guides/deploy/share-your-agent-link"},{"title":"Embed the widget","icon":"code","mode":"how-to","href":"/guides/deploy/embed-the-widget"},{"title":"Design the widget","icon":"palette","mode":"how-to","href":"/guides/deploy/design-the-widget"},{"title":"Add your agent to a mobile app","icon":"mobile-screen","mode":"how-to","href":"/guides/deploy/mobile-apps"},{"group":"WhatsApp","icon":"whatsapp","pages":[{"title":"Channels overview","icon":"share-nodes","mode":"concept","href":"/guides/channels/channels-overview"},{"title":"Connect WhatsApp","sidebarTitle":"Connect a number","icon":"link","mode":"how-to","href":"/guides/channels/connect-whatsapp"},{"title":"Manage WhatsApp templates","sidebarTitle":"Templates","icon":"file-lines","mode":"how-to","href":"/guides/channels/whatsapp-templates"}]}]},{"group":"Conversations \u0026 activity","icon":"wave-pulse","expanded":false,"pages":[{"title":"Watch conversations","icon":"eye","mode":"how-to","href":"/guides/activity/watch-conversations"},{"title":"Export conversations","icon":"file-export","mode":"how-to","href":"/guides/activity/export-conversations"},{"title":"What end users see","icon":"comments","mode":"concept","href":"/guides/activity/end-user-experience"}]},{"group":"Live chat","icon":"headset","expanded":false,"pages":[{"title":"Live-chat overview and seats","sidebarTitle":"Overview and seats","icon":"circle-info","mode":"concept","href":"/guides/live-chat/overview-and-seats"},{"title":"Work the inbox","icon":"inbox","mode":"how-to","href":"/guides/live-chat/work-the-inbox"},{"title":"Use the Agent Workspace","icon":"desktop","mode":"how-to","href":"/guides/live-chat/agent-workspace"},{"group":"Run your support team","icon":"users-gear","pages":[{"title":"Set up inboxes","icon":"gear","mode":"how-to","href":"/guides/live-chat/set-up-inboxes"},{"title":"Assignment and availability","icon":"user-clock","mode":"how-to","href":"/guides/live-chat/assignment-and-availability"},{"title":"Live chat notifications","icon":"bell","mode":"how-to","href":"/guides/live-chat/notifications"},{"title":"Collect CSAT ratings","icon":"face-smile","mode":"how-to","href":"/guides/live-chat/csat"}]},{"title":"Use Copilot","icon":"wand-magic-sparkles","mode":"how-to","href":"/guides/live-chat/copilot"}]},{"group":"End users","icon":"address-book","expanded":false,"pages":[{"title":"End user profiles","icon":"id-card","mode":"concept","href":"/guides/end-users/profiles"},{"title":"Verify end user identity","icon":"user-check","mode":"how-to","href":"/guides/end-users/verify-identity"},{"title":"Organize and moderate end users","sidebarTitle":"Organize and moderate","icon":"tags","mode":"how-to","href":"/guides/end-users/organize-and-moderate"},{"title":"Import and export end users","sidebarTitle":"Import and export","icon":"file-import","mode":"how-to","href":"/guides/end-users/import-and-export"},{"title":"Build end user segments","icon":"filter","mode":"how-to","href":"/guides/end-users/segments"},{"title":"End user consent","icon":"shield-check","mode":"concept","href":"/guides/end-users/consent"}]},{"group":"Campaigns","icon":"megaphone","expanded":false,"pages":[{"title":"Campaigns overview","sidebarTitle":"Overview","icon":"circle-info","mode":"concept","href":"/guides/campaigns/campaigns-overview"},{"title":"Create a campaign","icon":"plus","mode":"how-to","href":"/guides/campaigns/create-a-campaign"},{"title":"Handle campaign replies","icon":"reply","mode":"how-to","href":"/guides/campaigns/handle-replies"},{"title":"Run webhook campaigns","sidebarTitle":"Webhook campaigns","icon":"bolt","mode":"how-to","href":"/guides/campaigns/webhook-campaigns"},{"title":"Read campaign reports","icon":"chart-simple","mode":"how-to","href":"/guides/campaigns/campaign-reports"},{"title":"Fund your campaign wallet","icon":"wallet","mode":"how-to","href":"/guides/campaigns/campaign-wallet"}]},{"group":"Analytics","icon":"chart-line","expanded":false,"pages":[{"title":"Analytics overview","sidebarTitle":"Overview","icon":"circle-info","mode":"concept","href":"/guides/analytics/analytics-overview"},{"title":"Read the Analytics cards","icon":"gauge","mode":"how-to","href":"/guides/analytics/overview-tab"},{"title":"Find topics in conversations","icon":"tags","mode":"how-to","href":"/guides/analytics/topics"}]},{"group":"Organization \u0026 billing","icon":"credit-card","expanded":false,"pages":[{"title":"Roles and permissions","icon":"user-lock","mode":"reference","href":"/guides/billing/roles-and-permissions"},{"title":"Upgrade your plan","icon":"arrow-up-right-dots","mode":"how-to","href":"/guides/billing/plans-and-upgrading"},{"title":"Conversation usage","icon":"calculator","mode":"concept","href":"/guides/billing/conversation-usage"},{"title":"Manage live-chat seats","icon":"chair","mode":"how-to","href":"/guides/billing/live-chat-seats"},{"title":"Resolve invoices and payment issues","icon":"receipt","mode":"how-to","href":"/guides/billing/invoices-and-payment-issues"},{"title":"Organization lifecycle","icon":"arrows-rotate","mode":"concept","href":"/guides/billing/organization-lifecycle"}]},{"group":"Security \u0026 trust","icon":"shield-check","expanded":false,"pages":[{"title":"Search and export the audit log","icon":"clipboard-list","mode":"how-to","href":"/guides/security/audit-log"},{"title":"Stream audit events to your SIEM","icon":"tower-broadcast","mode":"how-to","href":"/guides/security/siem-streaming"},{"title":"Provider keys","icon":"key","mode":"how-to","href":"/guides/security/provider-keys"},{"title":"Data retention","icon":"clock-rotate-left","mode":"reference","href":"/guides/security/data-retention"},{"title":"Erasure and legal holds","icon":"scale-balanced","mode":"concept","href":"/guides/security/erasure-and-legal-holds"},{"title":"How Tars support accesses your organization","icon":"user-shield","mode":"concept","href":"/guides/security/how-tars-support-accesses-your-org"},{"title":"How Tars protects files, data, and identity","icon":"lock","mode":"concept","href":"/guides/security/data-protection"},{"title":"Personal data protection","icon":"user-shield","mode":"concept","href":"/guides/security/personal-data-protection"}]}]},{"group":"Developer","icon":"code","pages":[{"group":"Start here","icon":"map","expanded":false,"pages":[{"title":"API reference","icon":"code","mode":"concept","href":"/developer/index"},{"title":"API authentication","icon":"code","mode":"concept","href":"/developer/authentication"},{"title":"API requests","icon":"code","mode":"concept","href":"/developer/requests"},{"title":"API errors","icon":"code","mode":"concept","href":"/developer/errors"}]},{"group":"APIs","icon":"brackets-curly","expanded":false,"pages":[{"title":"Start a conversation","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/conversations","href":"/developer/api/conversations"},{"title":"Send a channel message","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/messages","href":"/developer/api/messages"},{"group":"Contacts","icon":"address-book","pages":[{"title":"Contacts API","icon":"code","mode":"concept","href":"/developer/api/contacts"},{"title":"List contacts","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/contacts","href":"/developer/api/contacts/list"},{"title":"Create a contact","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/contacts","href":"/developer/api/contacts/create"},{"title":"Create contacts in a batch","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/contacts/batch","href":"/developer/api/contacts/batch"},{"title":"Get a contact","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/contacts/{id}","href":"/developer/api/contacts/get"},{"title":"Update a contact","icon":"code","mode":"reference","openapi":"api-reference/openapi.json PATCH /api/v1/contacts/{id}","href":"/developer/api/contacts/update"},{"title":"Delete a contact","icon":"code","mode":"reference","openapi":"api-reference/openapi.json DELETE /api/v1/contacts/{id}","href":"/developer/api/contacts/delete"}]},{"group":"Campaigns","icon":"megaphone","pages":[{"title":"Campaigns API","icon":"code","mode":"concept","href":"/developer/api/campaigns"},{"title":"Send a campaign message","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/campaigns/{id}/send","href":"/developer/api/campaigns/send"},{"title":"Validate a campaign message","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/campaigns/{id}/validate","href":"/developer/api/campaigns/validate"}]},{"group":"Calls","pages":[{"title":"Calls API","icon":"code","mode":"concept","href":"/developer/api/calls"},{"title":"List calls","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/calls","href":"/developer/api/calls/list"},{"title":"Search calls","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/calls/search","href":"/developer/api/calls/search"},{"title":"Get a call","icon":"code","description":"Read a call's detail, variables, transcript and signed recording links.","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/calls/{id}","href":"/developer/api/calls/get"},{"title":"Place or schedule a call","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/calls","href":"/developer/api/calls/create"},{"title":"Update call metadata","icon":"code","description":"Change a call's metadata and return its current detail with privacy protections applied.","mode":"reference","openapi":"api-reference/openapi.json PATCH /api/v1/calls/{id}","href":"/developer/api/calls/update"},{"title":"Delete call content","icon":"code","mode":"reference","openapi":"api-reference/openapi.json DELETE /api/v1/calls/{id}","href":"/developer/api/calls/delete"},{"title":"Stop a call","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/calls/{id}/stop","href":"/developer/api/calls/stop"},{"title":"Read call concurrency","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/calls/concurrency","href":"/developer/api/calls/concurrency"}]},{"title":"Download a recording","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/artefacts/{id}","href":"/developer/api/artefacts"},{"group":"Agents","pages":[{"title":"Agents API","icon":"code","mode":"concept","href":"/developer/api/agents"},{"title":"List AI agents","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/agents","href":"/developer/api/agents/list"},{"title":"Get an AI agent","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/agents/{id}","href":"/developer/api/agents/get"}]},{"title":"List phone numbers","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/phone-numbers","href":"/developer/api/phone-numbers"},{"group":"Webhooks","pages":[{"title":"Webhooks API","icon":"code","mode":"concept","href":"/developer/api/webhooks"},{"title":"List webhook destinations","icon":"code","mode":"reference","openapi":"api-reference/openapi.json GET /api/v1/webhooks","href":"/developer/api/webhooks/list"},{"title":"Create a webhook destination","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/webhooks","href":"/developer/api/webhooks/create"},{"title":"Update a webhook destination","icon":"code","mode":"reference","openapi":"api-reference/openapi.json PATCH /api/v1/webhooks/{id}","href":"/developer/api/webhooks/update"},{"title":"Delete a webhook destination","icon":"code","mode":"reference","openapi":"api-reference/openapi.json DELETE /api/v1/webhooks/{id}","href":"/developer/api/webhooks/delete"},{"title":"Rotate a webhook secret","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/webhooks/{id}/rotate","href":"/developer/api/webhooks/rotate"},{"title":"Send a webhook test","icon":"code","mode":"reference","openapi":"api-reference/openapi.json POST /api/v1/webhooks/{id}/test","href":"/developer/api/webhooks/test"}]}]},{"group":"Webhooks","pages":[{"title":"Receive events from Tars","icon":"code","mode":"concept","href":"/developer/webhooks/index"},{"title":"Webhook event catalogue","icon":"code","mode":"concept","href":"/developer/webhooks/events"},{"title":"Verify requests from Tars","icon":"code","mode":"concept","href":"/developer/verify-requests"},{"title":"Requests your agents send","icon":"code","mode":"concept","href":"/developer/agent-requests"}]},{"group":"AI tools","pages":[{"title":"Connect AI tools with MCP","icon":"code","mode":"concept","href":"/developer/mcp"}]},{"group":"Web embed","icon":"globe","expanded":false,"pages":[{"title":"Embed script and TarsConfig","icon":"code","mode":"reference","href":"/developer/embed/script-and-config"},{"title":"Widget JS API","icon":"js","mode":"reference","href":"/developer/embed/widget-js-api"},{"title":"Host page events","icon":"tower-broadcast","mode":"reference","href":"/developer/embed/host-page-events"},{"title":"Iframe embed method","icon":"window-maximize","mode":"reference","href":"/developer/embed/iframe-method"},{"title":"Identity signing","icon":"code","mode":"reference","href":"/developer/embed/identity-signing"}]},{"group":"Mobile","icon":"mobile-screen","expanded":false,"pages":[{"title":"The WebView bridge","icon":"bridge","mode":"concept","href":"/developer/mobile/webview-bridge"},{"title":"React Native integration","icon":"react","mode":"reference","href":"/developer/mobile/react-native"},{"title":"Swift integration","icon":"swift","mode":"reference","href":"/developer/mobile/swift"},{"title":"Kotlin integration","icon":"android","mode":"reference","href":"/developer/mobile/kotlin"},{"title":"Bridge events reference","icon":"bolt","mode":"reference","href":"/developer/mobile/bridge-events"}]}]}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Place or schedule a call - Tars Docs","buildId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","deploymentId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DsGgv5pK.js","utils-B0h6ZXi-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-IgrnFwPw.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C49-TBER.js","snippetPresets-BPHn-9OB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CGBwAHwX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BjABHCCH.js","shallow-C0Uj5sOI.js","getApiPlaygroundDisplay-BnYiIeY4.js","CodeSnippet-BJWWrlBw.js","CodeSnippets-bxE5aDye.js","Page-BBU7roUf.js","getPastedJson-BAjriezQ.js","icon-BqcS52QC.js","MethodPill-BPGyN9me.js","DuplicateIcon-CCf2giLL.js","createIcon-CVH8aNt2.js","DynamicMarkdown-BklwmxA6.js","SectionHeading-DYCZQFxh.js","axios-vUo_bRtp.js","Markdown-D26rHnOC.js","clsx-DkiOUx4h.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DI8jfVGc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DwJy-csb.js"]}