The canonical topic guidance retrieved by the TFU Live conversational builder.
The conversational builder uses these topics when you change an agent or campaign.
For setup steps, see Build a TFU Live agent.
overview
Choose the part of the agent or campaign to change.
editing
Preserve existing content and save against the reviewed revision.
capabilities
Discover supported business abilities and connected resources.
campaigns
Change triggers, caller settings and follow-up timing.
readiness
Distinguish saved drafts, verified revisions and activation.
going_live
The CRM choice (or a move onto GoHighLevel), the calling line and going live.
Public operation support
These states come from the same registry as the request guards. Paths are relative
to one TFU Live agent. Runtime support does not grant scopes or establish readiness.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Team Follow Up API Docs","description":"Voice agents for GoHighLevel agencies: call every lead within a minute, book the appointment, and prove what happened. Guides and API reference for agents, campaigns, calls, contacts, phone numbers and analytics.","colors":{"primary":"#1066BC","light":"#1066BC","dark":"#1066BC"},"logo":{"light":"https://mintcdn.com/teamfollowupai/-K3ftiAApBs7M-rV/logo/teamfollowup.png?fit=max\u0026auto=format\u0026n=-K3ftiAApBs7M-rV\u0026q=85\u0026s=39eb7926e7a1140e67ff17d1b49319c6","dark":"https://mintcdn.com/teamfollowupai/-K3ftiAApBs7M-rV/logo/teamfollowup.png?fit=max\u0026auto=format\u0026n=-K3ftiAApBs7M-rV\u0026q=85\u0026s=39eb7926e7a1140e67ff17d1b49319c6","href":"/"},"favicon":"https://mintcdn.com/teamfollowupai/-K3ftiAApBs7M-rV/logo/teamfollowup.png?fit=max\u0026auto=format\u0026n=-K3ftiAApBs7M-rV\u0026q=85\u0026s=39eb7926e7a1140e67ff17d1b49319c6","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","autogenerate":true}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"links":[{"icon":"headset","href":"https://join.slack.com/t/diyteamfollow-oqz3480/shared_invite/zt-3z4e6feuc-jJa8wC_4CXShhA8lChf99A","label":"Support"},{"icon":"chart-line","href":"https://status.teamfollowup.ai","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.teamfollowup.ai"}},"fonts":{"heading":{"family":"Geist","weight":700},"body":{"family":"Geist","weight":400}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"markdown":{"schema":true,"instructions":["Use the public API base URL: https://api.teamfollowup.ai/api.","Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.","Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers.","Scope requests by locationId rather than projectName.","Read the guide linked from each API reference group before recommending an endpoint."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"teamfollowupai","hasAudioNarration":false,"actualSubdomain":"teamfollowupai","customDomains":["docs.teamfollowup.ai"],"gitSource":{"type":"github","owner":"team-follow-up-ai","repo":"tfuai","deployBranch":"main","contentDirectory":"saas/server/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af70d799b8f20269efa9bd2","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"API Reference","count":213},{"language":"default","tag":"Documentation","count":92},{"language":"default","tag":"TFU Live","count":71},{"language":"default","tag":"Campaigns","count":44},{"language":"default","tag":"Agents","count":33},{"language":"default","tag":"Native Contacts","count":24},{"language":"default","tag":"Native Calendar","count":22},{"language":"default","tag":"Billing","count":21},{"language":"default","tag":"Power Dialer","count":13},{"language":"default","tag":"In-call Capabilities","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--font-inter: \"Geist Variable\", \"Geist\", system-ui, sans-serif;--font-paper-mono: \"Geist Mono\", ui-monospace, monospace;--default-font-family: \"Geist Variable\", \"Geist\", system-ui, sans-serif;--default-mono-font-family: \"Geist Mono\", ui-monospace, monospace;--font-family-headings-custom: \"Geist Variable\", \"Geist\", system-ui, sans-serif;--font-family-body-custom: \"Geist Variable\", \"Geist\", system-ui, sans-serif;--font-family-mono-custom: \"Geist Mono\", ui-monospace, monospace;--twoslash-code-font: \"Geist Mono\", ui-monospace, monospace;--background-light: 255 255 255;--background-dark: 10 10 10;--gray-50: 250 250 250;--gray-100: 237 237 237;--gray-200: 230 230 230;--gray-300: 212 212 212;--gray-400: 163 163 163;--gray-500: 92 92 92;--gray-600: 64 64 64;--gray-700: 38 38 38;--gray-800: 28 28 28;--gray-900: 18 18 18;--gray-950: 10 10 10}html,body{font-family:\"Geist Variable\", \"Geist\", system-ui, sans-serif}#header>.prose{font-size:1rem;line-height:1.75}:where(code,pre,kbd,samp),.font-mono,.font-family-mono,[data-component-part=\"code-block-root\"],.code-block pre,.code-block code,.shiki,.shiki code{font-family:\"Geist Mono\", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas,\n \"Liberation Mono\", \"Courier New\", monospace!important}.dark .code-block [data-component-part=\"code-block-root\"],.dark .code-block pre,.dark .code-block code{--shiki-dark-bg: #0a0a0a !important;background-color:rgb(10 10 10)!important;font-family:\"Geist Mono\", ui-monospace, monospace!important}.dark .code-block [data-fade-overlay=\"true\"]{--fade-color-dark: #0a0a0a !important}@media (min-width: 1024px){:root{--tfuai-sidebar-width: 16.5rem;--tfuai-navbar-x-padding: 1.75rem}#navbar>.z-10.mx-auto.relative>.relative>.flex.items-center>.h-full.relative{width:100%}#navbar>.z-10.mx-auto.relative>.relative>.flex.items-center>.h-full.relative>.flex-1.flex.items-center.gap-x-4{flex:0 1 calc(var(--tfuai-sidebar-width) - 0.75rem)!important;min-width:3rem}#navbar>.z-10.mx-auto.relative>.relative>.flex.items-center>.h-full.relative>.flex.items-center.gap-4{flex:1 1 auto!important;min-width:0}#navbar>.z-10.mx-auto.relative>.relative>.flex.items-center>.h-full.relative>.flex.items-center.gap-4>.flex-1.relative.hidden.lg\\:flex{width:100%;flex:1 1 auto!important;justify-content:space-between;gap:clamp(2rem, 4vw, 5rem);margin-left:0!important}#navbar .nav-tabs{flex:0 0 auto}#navbar nav[aria-label=\"Main\"]{flex:0 0 auto;margin-left:auto}}"}],"page":{"pagePath":"tfu-live/builder-guidance","slug":"/tfu-live/builder-guidance","pageMetadata":{"title":"TFU Live builder guidance","description":"The canonical topic guidance retrieved by the TFU Live conversational builder.","assistant":"linked","tools":"","chat_tools":"","href":"/tfu-live/builder-guidance"},"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: \"The canonical topic guidance retrieved by the TFU Live conversational builder.\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The conversational builder uses these topics when you change an agent or campaign.\nFor setup steps, see `,_jsx(_components.a,{href:`/tfu-live/authoring`,children:`Build a TFU Live agent`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`overview`}),`\n`,_jsx(_components.p,{children:`Choose the part of the agent or campaign to change.`}),`\n`,_jsx(Heading,{level:`2`,id:`editing`,children:`editing`}),`\n`,_jsx(_components.p,{children:`Preserve existing content and save against the reviewed revision.`}),`\n`,_jsx(Heading,{level:`2`,id:`capabilities`,children:`capabilities`}),`\n`,_jsx(_components.p,{children:`Discover supported business abilities and connected resources.`}),`\n`,_jsx(Heading,{level:`2`,id:`campaigns`,children:`campaigns`}),`\n`,_jsx(_components.p,{children:`Change triggers, caller settings and follow-up timing.`}),`\n`,_jsx(Heading,{level:`2`,id:`readiness`,children:`readiness`}),`\n`,_jsx(_components.p,{children:`Distinguish saved drafts, verified revisions and activation.`}),`\n`,_jsx(Heading,{level:`2`,id:`going_live`,children:`going_live`}),`\n`,_jsx(_components.p,{children:`The CRM choice (or a move onto GoHighLevel), the calling line and going live.`}),`\n`,_jsx(Heading,{level:`2`,id:`public-operation-support`,children:`Public operation support`}),`\n`,_jsx(_components.p,{children:`These states come from the same registry as the request guards. Paths are relative\nto one TFU Live agent. Runtime support does not grant scopes or establish readiness.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Operation`}),_jsx(_components.th,{children:`Runtime support`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST, PATCH, DELETE /`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /operations`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /go-live-check`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /go-live`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /pause`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST /numbers`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /brain/catalog`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /prepare`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /sync-workflows`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /history`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /restore`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /clone`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /clone/plan`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST /crm-connection`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST /move`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /move/plan`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PUT /orb`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PUT /labels`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /chat-readiness`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST /chat-tests`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST, DELETE /test-share-links`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST, PUT, DELETE /workflows`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET /resources`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, PATCH /campaign`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, PATCH /outcome-prompts`}),_jsx(_components.td,{children:`not_applicable`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PATCH /post-call-field`}),_jsx(_components.td,{children:`not_applicable`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, PUT, PATCH, POST, DELETE /campaign/workflow`}),_jsx(_components.td,{children:`not_applicable`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST, PATCH, DELETE /split-test`}),_jsx(_components.td,{children:`not_implemented`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST /campaign/master`}),_jsx(_components.td,{children:`not_implemented`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, POST, PUT, PATCH, DELETE /skills`}),_jsx(_components.td,{children:`not_implemented`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET, PATCH /tools`}),_jsx(_components.td,{children:`not_implemented`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`in-the-api`,children:`In the API`}),`\n`,_jsxs(_components.p,{children:[`Customer backends use `,_jsx(_components.a,{href:`/api-reference/tfu-live/create-tfu-live-agent`,children:`Create agent`}),`,\n`,_jsx(_components.a,{href:`/api-reference/tfu-live/get-tfu-live-agent`,children:`Get agent`}),` and\n`,_jsx(_components.a,{href:`/api-reference/tfu-live/update-tfu-live-agent`,children:`Update agent`}),` with the\n`,_jsx(_components.a,{href:`/tfu-live/authoring`,children:`TFU Live contract`}),`. See the `,_jsx(_components.a,{href:`/glossary#agents`,children:`Agent glossary`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/tfu-live/authoring`,children:`Build a TFU Live agent`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"TFU Live builder guidance","description":"The canonical topic guidance retrieved by the TFU Live conversational builder.","assistant":"linked","tools":"","chat_tools":"","href":"/tfu-live/builder-guidance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"overview","slug":"overview","depth":2,"children":[]},{"title":"editing","slug":"editing","depth":2,"children":[]},{"title":"capabilities","slug":"capabilities","depth":2,"children":[]},{"title":"campaigns","slug":"campaigns","depth":2,"children":[]},{"title":"readiness","slug":"readiness","depth":2,"children":[]},{"title":"going_live","slug":"going_live","depth":2,"children":[]},{"title":"Public operation support","slug":"public-operation-support","depth":2,"children":[]},{"title":"In the API","slug":"in-the-api","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"teamfollowupai","siteName":"Team Follow Up API Docs","title":"TFU Live builder guidance - Team Follow Up API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T23:10:39.116Z","originalFileLocation":"tfu-live/builder-guidance.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=\"dark\"}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=\"The canonical topic guidance retrieved by the TFU Live conversational builder.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Team Follow Up API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"TFU Live builder guidance - Team Follow Up API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The canonical topic guidance retrieved by the TFU Live conversational builder.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Team Follow Up API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.teamfollowup.ai/tfu-live/builder-guidance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://teamfollowupai.mintlify.site/_mintlify/api/og/v2?division=TFU+Live\u0026amp;title=TFU+Live+builder+guidance\u0026amp;description=The+canonical+topic+guidance+retrieved+by+the+TFU+Live+conversational+builder.\u0026amp;theme=71791147ff1d0e3f7e4b67ca\u0026amp;signature=dff359f73845b375b1889df96f60ab4f7fea6f22349fe8500db2eedcf99112da\">\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=\"TFU Live builder guidance - Team Follow Up API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The canonical topic guidance retrieved by the TFU Live conversational builder.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://teamfollowupai.mintlify.site/_mintlify/api/og/v2?division=TFU+Live\u0026amp;title=TFU+Live+builder+guidance\u0026amp;description=The+canonical+topic+guidance+retrieved+by+the+TFU+Live+conversational+builder.\u0026amp;theme=71791147ff1d0e3f7e4b67ca\u0026amp;signature=dff359f73845b375b1889df96f60ab4f7fea6f22349fe8500db2eedcf99112da\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/teamfollowupai/SX0A_MKwmcLqeq0O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Team Follow Up API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1066BC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.teamfollowup.ai/tfu-live/builder-guidance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/tfu-live/builder-guidance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.teamfollowup.ai/#organization\",\"name\":\"Team Follow Up API Docs\",\"url\":\"https://docs.teamfollowup.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/teamfollowupai/-K3ftiAApBs7M-rV/logo/teamfollowup.png?fit=max\u0026auto=format\u0026n=-K3ftiAApBs7M-rV\u0026q=85\u0026s=39eb7926e7a1140e67ff17d1b49319c6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.teamfollowup.ai#website\",\"name\":\"Team Follow Up API Docs\",\"url\":\"https://docs.teamfollowup.ai\",\"publisher\":{\"@id\":\"https://docs.teamfollowup.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance#webpage\",\"url\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance\",\"name\":\"TFU Live builder guidance\",\"description\":\"The canonical topic guidance retrieved by the TFU Live conversational builder.\",\"dateModified\":\"2026-11-11T23:10:39.116Z\",\"isPartOf\":{\"@id\":\"https://docs.teamfollowup.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"TFU Live\",\"item\":\"https://docs.teamfollowup.ai/api-reference/tfu-live\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"TFU Live builder guidance\",\"item\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance#article\",\"headline\":\"TFU Live builder guidance\",\"name\":\"TFU Live builder guidance\",\"description\":\"The canonical topic guidance retrieved by the TFU Live conversational builder.\",\"url\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.teamfollowup.ai/tfu-live/builder-guidance#webpage\"},\"dateModified\":\"2026-11-11T23:10:39.116Z\",\"publisher\":{\"@id\":\"https://docs.teamfollowup.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.teamfollowup.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Team Follow Up API Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Team Follow Up API Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/tfu-live/builder-guidance.md","siteName":"Team Follow Up API Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code-xml","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/api-reference/overview"},{"group":"Developer setup","pages":[{"title":"Authentication","href":"/authentication"},{"title":"Connect an AI assistant","sidebarTitle":"Connect an AI assistant","href":"/mcp-actions"},{"title":"Conventions","href":"/conventions"}]},{"group":"Agents","icon":"bot","expanded":false,"pages":[{"title":"Agents API","sidebarTitle":"Overview","href":"/api-reference/agents"},{"group":"Identity and settings","expanded":false,"pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Clone agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/clone","href":"/api-reference/agents/clone-agent"}]},{"group":"Split testing","expanded":false,"pages":[{"title":"Split Testing API","sidebarTitle":"Overview","href":"/api-reference/split-testing"},{"title":"Get split test","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/split-test","href":"/api-reference/agents/get-split-test"},{"title":"Convert campaign to split test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/split-test/convert","href":"/api-reference/agents/convert-campaign-to-split-test"},{"title":"Update split weights","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/split-test","href":"/api-reference/agents/update-split-weights"},{"title":"Add split variant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/split-test/variants","href":"/api-reference/agents/add-split-variant"},{"title":"Remove split variant","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/agents/{id}/split-test/variants/{variantAgentId}","href":"/api-reference/agents/remove-split-variant"},{"title":"Rename split variant","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/split-test/variants/{variantAgentId}","href":"/api-reference/agents/rename-split-variant"}]},{"group":"Conversation testing","expanded":false,"pages":[{"title":"Create test call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/test-call","href":"/api-reference/agents/create-test-call"},{"title":"Create web agent session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/web-version/session","href":"/api-reference/agents/create-web-agent-session"}]}]},{"group":"TFU Live","icon":"audio-lines","expanded":false,"pages":[{"title":"TFU Live authoring","sidebarTitle":"Overview","href":"/api-reference/tfu-live"},{"title":"Build a TFU Live agent","href":"/tfu-live/authoring"},{"title":"Workflows contract","description":"Every shape, rule, limit and error of a TFU Live agent's workflows, for editors and API clients building on the TFU Live API.","href":"/tfu-live/workflows-contract"},{"title":"TFU Live builder guidance","href":"/tfu-live/builder-guidance"},{"title":"TFU Live master families","description":"Read or set the relationship between campaigns that share one TFU Live agent.","href":"/tfu-live/master-families"},{"title":"Connect GoHighLevel to a TFU Live rep","href":"/tfu-live/connect-gohighlevel"},{"title":"Give a TFU Live rep a phone number","href":"/tfu-live/numbers"},{"title":"Take a TFU Live rep live, or pause it","href":"/tfu-live/go-live"},{"title":"Set up a TFU Live rep's campaign","href":"/tfu-live/campaign-settings"},{"title":"Move or copy a TFU Live rep","href":"/tfu-live/move-or-copy"},{"title":"Create TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents","href":"/api-reference/tfu-live/create-tfu-live-agent"},{"title":"List TFU Live agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents","href":"/api-reference/tfu-live/list-tfu-live-agents"},{"title":"List TFU Live Brain templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/brain-templates","href":"/api-reference/tfu-live/list-tfu-live-brain-templates"},{"title":"List TFU Live voices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/voices","href":"/api-reference/tfu-live/list-tfu-live-voices"},{"title":"Research a business website","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/website-intake","href":"/api-reference/tfu-live/research-a-business-website"},{"title":"Read website research","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/website-intake/{requestId}","href":"/api-reference/tfu-live/read-website-research"},{"title":"Get TFU Live creation status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/creation/{requestId}","href":"/api-reference/tfu-live/get-tfu-live-creation-status"},{"title":"Check TFU Live go-live readiness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/go-live-check","href":"/api-reference/tfu-live/check-tfu-live-go-live-readiness"},{"title":"Go live with TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/go-live","href":"/api-reference/tfu-live/go-live-with-tfu-live-agent"},{"title":"Pause TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/pause","href":"/api-reference/tfu-live/pause-tfu-live-agent"},{"title":"Get TFU Live agent numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/numbers","href":"/api-reference/tfu-live/get-tfu-live-agent-numbers"},{"title":"Search TFU Live agent numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/numbers/available","href":"/api-reference/tfu-live/search-tfu-live-agent-numbers"},{"title":"Quote a TFU Live number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/numbers/quote","href":"/api-reference/tfu-live/quote-a-tfu-live-number"},{"title":"Buy a TFU Live number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/numbers/purchase","href":"/api-reference/tfu-live/buy-a-tfu-live-number"},{"title":"List numbers to connect to a TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/numbers/attachable","href":"/api-reference/tfu-live/list-numbers-to-connect-to-a-tfu-live-agent"},{"title":"Connect a number to a TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/numbers/attach","href":"/api-reference/tfu-live/connect-a-number-to-a-tfu-live-agent"},{"title":"Get TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}","href":"/api-reference/tfu-live/get-tfu-live-agent"},{"title":"Update TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/tfu-live-agents/{id}","href":"/api-reference/tfu-live/update-tfu-live-agent"},{"title":"Delete TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/tfu-live-agents/{id}","href":"/api-reference/tfu-live/delete-tfu-live-agent"},{"title":"Set TFU Live agent labels","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tfu-live-agents/{id}/labels","href":"/api-reference/tfu-live/set-tfu-live-agent-labels"},{"title":"Check TFU Live SMS readiness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/chat-readiness","href":"/api-reference/tfu-live/check-tfu-live-sms-readiness"},{"title":"Start TFU Live chat test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/chat-tests","href":"/api-reference/tfu-live/start-tfu-live-chat-test"},{"title":"Get TFU Live chat test","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/chat-tests/{sessionId}","href":"/api-reference/tfu-live/get-tfu-live-chat-test"},{"title":"Send TFU Live chat test messages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/chat-tests/{sessionId}/messages","href":"/api-reference/tfu-live/send-tfu-live-chat-test-messages"},{"title":"End TFU Live chat test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/chat-tests/{sessionId}/end","href":"/api-reference/tfu-live/end-tfu-live-chat-test"},{"title":"Process pending TFU Live test texts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/chat-tests/{sessionId}/settle","href":"/api-reference/tfu-live/process-pending-tfu-live-test-texts"},{"title":"Get TFU Live test callbacks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/chat-tests/{sessionId}/callbacks","href":"/api-reference/tfu-live/get-tfu-live-test-callbacks"},{"title":"Set TFU Live test callback outcome","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/chat-tests/{sessionId}/callbacks/{callbackId}/disposition","href":"/api-reference/tfu-live/set-tfu-live-test-callback-outcome"},{"title":"Prepare TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/prepare","href":"/api-reference/tfu-live/prepare-tfu-live-agent"},{"title":"Sync TFU Live workflows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/sync-workflows","href":"/api-reference/tfu-live/sync-tfu-live-workflows"},{"title":"List TFU Live agent history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/history","href":"/api-reference/tfu-live/list-tfu-live-agent-history"},{"title":"Restore TFU Live agent revision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/restore","href":"/api-reference/tfu-live/restore-tfu-live-agent-revision"},{"title":"Make a TFU Live version of an existing agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/from-legacy","href":"/api-reference/tfu-live/make-a-tfu-live-version-of-an-existing-agent"},{"title":"Clone TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/clone","href":"/api-reference/tfu-live/clone-tfu-live-agent"},{"title":"Move TFU Live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/move","href":"/api-reference/tfu-live/move-tfu-live-agent"},{"title":"Preview TFU Live agent clone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/clone/plan","href":"/api-reference/tfu-live/preview-tfu-live-agent-clone"},{"title":"Preview TFU Live agent move","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/move/plan","href":"/api-reference/tfu-live/preview-tfu-live-agent-move"},{"title":"Create TFU Live GoHighLevel install link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/crm-connection","href":"/api-reference/tfu-live/create-tfu-live-gohighlevel-install-link"},{"title":"Check TFU Live GoHighLevel connection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/crm-connection","href":"/api-reference/tfu-live/check-tfu-live-gohighlevel-connection"},{"title":"Set TFU Live agent orb colour","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tfu-live-agents/{id}/orb","href":"/api-reference/tfu-live/set-tfu-live-agent-orb-colour"},{"title":"Issue TFU Live test links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/test-share-links","href":"/api-reference/tfu-live/issue-tfu-live-test-links"},{"title":"Revoke TFU Live test links","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/tfu-live-agents/{id}/test-share-links/{scope}","href":"/api-reference/tfu-live/revoke-tfu-live-test-links"},{"title":"Get TFU Live catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/brain/catalog","href":"/api-reference/tfu-live/get-tfu-live-catalog"},{"title":"Get TFU Live operation support","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/operations","href":"/api-reference/tfu-live/get-tfu-live-operation-support"},{"title":"List TFU Live workflows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/workflows","href":"/api-reference/tfu-live/list-tfu-live-workflows"},{"title":"Create TFU Live workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/workflows","href":"/api-reference/tfu-live/create-tfu-live-workflow"},{"title":"Validate TFU Live workflows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tfu-live-agents/{id}/workflows/validate","href":"/api-reference/tfu-live/validate-tfu-live-workflows"},{"title":"Get TFU Live workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/workflows/{workflowId}","href":"/api-reference/tfu-live/get-tfu-live-workflow"},{"title":"Replace TFU Live workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tfu-live-agents/{id}/workflows/{workflowId}","href":"/api-reference/tfu-live/replace-tfu-live-workflow"},{"title":"Delete TFU Live workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/tfu-live-agents/{id}/workflows/{workflowId}","href":"/api-reference/tfu-live/delete-tfu-live-workflow"},{"title":"Look up TFU Live resources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tfu-live-agents/{id}/resources/{kind}","href":"/api-reference/tfu-live/look-up-tfu-live-resources"},{"title":"Read TFU Live master campaign families","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/projects/{locationId}/tfu-live-families","href":"/api-reference/tfu-live/read-tfu-live-master-campaign-families"},{"title":"Set a TFU Live master campaign family","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/agent-builder/projects/{locationId}/tfu-live-families/{profileId}","href":"/api-reference/tfu-live/set-a-tfu-live-master-campaign-family"}]},{"group":"In-call Capabilities","icon":"puzzle","expanded":false,"pages":[{"title":"Skills \u0026 Tools API","sidebarTitle":"Overview","href":"/api-reference/skills-and-tools"},{"title":"List available tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/tools","href":"/api-reference/in-call-capabilities/list-available-tools"},{"title":"Update a tool description","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/tools","href":"/api-reference/in-call-capabilities/update-a-tool-description"},{"group":"Individual skills","expanded":false,"pages":[{"title":"List agent skills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/skills","href":"/api-reference/in-call-capabilities/list-agent-skills"},{"title":"Create an agent skill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/skills","href":"/api-reference/in-call-capabilities/create-an-agent-skill"},{"title":"Update one agent skill","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/skills/{skillId}","href":"/api-reference/in-call-capabilities/update-one-agent-skill"},{"title":"Delete one agent skill","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/agents/{id}/skills/{skillId}","href":"/api-reference/in-call-capabilities/delete-one-agent-skill"}]}]},{"group":"Campaigns","icon":"phone","expanded":false,"pages":[{"title":"Campaigns API","sidebarTitle":"Overview","href":"/api-reference/campaigns"},{"title":"Get campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/campaign","href":"/api-reference/campaigns/get-campaign"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/campaign","href":"/api-reference/campaigns/update-campaign"},{"title":"Enroll existing leads","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/campaign/enroll-existing-leads","href":"/api-reference/campaigns/enroll-existing-leads"},{"group":"Power Dialer","expanded":false,"pages":[{"title":"Power Dialer API","sidebarTitle":"Overview","href":"/api-reference/power-dialer"},{"title":"Get queue summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/power-dialer/summary","href":"/api-reference/campaigns/get-queue-summary"},{"title":"Get pipeline steps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/power-dialer/pipeline/steps","href":"/api-reference/campaigns/get-pipeline-steps"},{"title":"List pipeline leads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/power-dialer/pipeline/leads","href":"/api-reference/campaigns/list-pipeline-leads"},{"title":"List callback leads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/power-dialer/pipeline/callbacks","href":"/api-reference/campaigns/list-callback-leads"},{"title":"List parked speed-to-lead leads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/power-dialer/pipeline/s2l-parked","href":"/api-reference/campaigns/list-parked-speed-to-lead-leads"},{"title":"Run lead touchpoints now","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/power-dialer/run-now","href":"/api-reference/campaigns/run-lead-touchpoints-now"},{"title":"Move leads to another step","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/power-dialer/move","href":"/api-reference/campaigns/move-leads-to-another-step"},{"title":"Remove leads from cadence","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/power-dialer/remove","href":"/api-reference/campaigns/remove-leads-from-cadence"}]},{"group":"Call results","expanded":false,"pages":[{"title":"Campaign Workflows API","sidebarTitle":"Overview","href":"/api-reference/campaign-workflows"},{"title":"Get the campaign workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/campaign/workflow","href":"/api-reference/campaigns/get-the-campaign-workflow"},{"title":"Add actions to an outcome","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/campaign/workflow/outcomes/{outcome}/nodes","href":"/api-reference/campaigns/add-actions-to-an-outcome"},{"title":"Replace the entire workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/agent-builder/agents/{id}/campaign/workflow","href":"/api-reference/campaigns/replace-the-entire-workflow"},{"title":"Update settings or node contents","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/agent-builder/agents/{id}/campaign/workflow","href":"/api-reference/campaigns/update-settings-or-node-contents"},{"title":"Remove a workflow node","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/agents/{id}/campaign/workflow/nodes/{nodeId}","href":"/api-reference/campaigns/remove-a-workflow-node"}]},{"group":"Campaign testing","expanded":false,"pages":[{"title":"Create campaign test run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/campaign/test-runs","href":"/api-reference/campaigns/create-campaign-test-run"},{"title":"Get campaign test run status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/campaign/test-runs/{intentId}","href":"/api-reference/campaigns/get-campaign-test-run-status"},{"title":"List campaign runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/campaign/runs","href":"/api-reference/campaigns/list-campaign-runs"}]}]},{"group":"Master agent","icon":"layers","expanded":false,"pages":[{"title":"Get master agent state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/agents/{id}/campaign/master","href":"/api-reference/master-agent/get-master-agent-state"},{"title":"Link a project to this master agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/agents/{id}/campaign/master/projects","href":"/api-reference/master-agent/link-a-project-to-this-master-agent"}]},{"group":"Phone Numbers","icon":"phone-call","expanded":false,"pages":[{"title":"Phone Numbers API","sidebarTitle":"Overview","href":"/api-reference/phone-numbers"},{"group":"Find numbers","expanded":false,"pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Search phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/phone-numbers/search","href":"/api-reference/phone-numbers/search-phone-numbers"}]},{"group":"Agent assignments","expanded":false,"pages":[{"title":"Assign phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/phone-numbers/{number}/assign","href":"/api-reference/phone-numbers/assign-phone-number"},{"title":"Unassign phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/phone-numbers/{number}/campaigns/{campaignId}","href":"/api-reference/phone-numbers/unassign-phone-number"},{"title":"Move phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/phone-numbers/{number}/campaigns/{campaignId}/move","href":"/api-reference/phone-numbers/move-phone-number"}]},{"group":"Buy and release","expanded":false,"pages":[{"title":"Buy phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/phone-numbers","href":"/api-reference/phone-numbers/buy-phone-number"},{"title":"Release phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/phone-numbers/{number}","href":"/api-reference/phone-numbers/release-phone-number"}]}]},{"group":"Caller ID","icon":"circle-check","expanded":false,"pages":[{"title":"Caller ID API","sidebarTitle":"Overview","href":"/api-reference/caller-id"},{"title":"Get caller ID status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/phone-trust/summary","href":"/api-reference/caller-id/get-caller-id-status"},{"title":"Register a business for caller ID","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/phone-trust/businesses/{locationId}/registration","href":"/api-reference/caller-id/register-a-business-for-caller-id"}]},{"group":"Voices","icon":"audio-lines","expanded":false,"pages":[{"title":"Voices API","sidebarTitle":"Overview","href":"/api-reference/voices"},{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/voices","href":"/api-reference/voices/list-voices"},{"title":"Get voice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/voices/{voiceId}","href":"/api-reference/voices/get-voice"},{"title":"Search for a voice to add","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/voices/search","href":"/api-reference/voices/search-for-a-voice-to-add"},{"title":"List added voices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/voices/library","href":"/api-reference/voices/list-added-voices"},{"title":"Add a voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/agent-builder/voices/library","href":"/api-reference/voices/add-a-voice"},{"title":"Preview removing a voice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/agent-builder/voices/library/{providerVoiceId}/impact","href":"/api-reference/voices/preview-removing-a-voice"},{"title":"Remove a voice","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/agent-builder/voices/library/{providerVoiceId}","href":"/api-reference/voices/remove-a-voice"}]},{"group":"Projects","icon":"folder","expanded":false,"pages":[{"title":"Projects API","sidebarTitle":"Overview","href":"/api-reference/projects"},{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v2/projects","href":"/api-reference/projects/list-projects"},{"title":"Create native sub-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v2/projects/native","href":"/api-reference/projects/create-native-sub-account"},{"title":"Get project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v2/projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Update project","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v2/projects/{id}","href":"/api-reference/projects/update-project"},{"title":"Delete project","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v2/projects/{id}","href":"/api-reference/projects/delete-project"}]},{"group":"Calls","icon":"history","expanded":false,"pages":[{"title":"Calls API","sidebarTitle":"Overview","href":"/api-reference/calls"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/call-history","href":"/api-reference/calls/list-calls"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/call-history/{callId}","href":"/api-reference/calls/get-call"},{"title":"Search call transcripts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/call-history/transcript-search","href":"/api-reference/calls/search-call-transcripts"}]},{"group":"Contacts","icon":"users","expanded":false,"pages":[{"title":"Contacts API","sidebarTitle":"Overview","href":"/api-reference/contacts"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}","href":"/api-reference/contacts/get-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/contacts/{contactId}","href":"/api-reference/contacts/update-contact"},{"title":"Add a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/add/{locationId}","href":"/api-reference/contacts/add-a-contact"}]},{"group":"Native Contacts","icon":"user-round","expanded":false,"pages":[{"title":"Native Contacts API","sidebarTitle":"Overview","href":"/api-reference/native-contacts"},{"title":"List native contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-contacts","href":"/api-reference/native-contacts/list-native-contacts"},{"title":"Create a native contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts","href":"/api-reference/native-contacts/create-a-native-contact"},{"title":"List custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-contacts/fields","href":"/api-reference/native-contacts/list-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/fields","href":"/api-reference/native-contacts/create-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/native-contacts/fields/{key}","href":"/api-reference/native-contacts/update-a-custom-field"},{"title":"Delete a custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/native-contacts/fields/{key}","href":"/api-reference/native-contacts/delete-a-custom-field"},{"title":"Get the lead link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-contacts/lead-webhook","href":"/api-reference/native-contacts/get-the-lead-link"},{"title":"Rotate the lead link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/lead-webhook/rotate","href":"/api-reference/native-contacts/rotate-the-lead-link"},{"title":"Import contacts from CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/import","href":"/api-reference/native-contacts/import-contacts-from-csv"},{"title":"Put contacts into a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/enroll","href":"/api-reference/native-contacts/put-contacts-into-a-campaign"},{"title":"Stop calling several native contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/bulk-do-not-call","href":"/api-reference/native-contacts/stop-calling-several-native-contacts"},{"title":"Delete several native contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/bulk-delete","href":"/api-reference/native-contacts/delete-several-native-contacts"},{"title":"Get a native contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-contacts/{contactId}","href":"/api-reference/native-contacts/get-a-native-contact"},{"title":"Update a native contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/native-contacts/{contactId}","href":"/api-reference/native-contacts/update-a-native-contact"},{"title":"Delete a native contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/native-contacts/{contactId}","href":"/api-reference/native-contacts/delete-a-native-contact"},{"title":"Preview a native contact delete","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-contacts/{contactId}/delete-preview","href":"/api-reference/native-contacts/preview-a-native-contact-delete"},{"title":"Set native contact do-not-call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/{contactId}/do-not-call","href":"/api-reference/native-contacts/set-native-contact-do-not-call"},{"title":"Add a native contact note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/{contactId}/notes","href":"/api-reference/native-contacts/add-a-native-contact-note"},{"title":"Add to contact memory","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/{contactId}/memory","href":"/api-reference/native-contacts/add-to-contact-memory"},{"title":"Update a contact memory entry","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/native-contacts/{contactId}/memory/{entryId}","href":"/api-reference/native-contacts/update-a-contact-memory-entry"},{"title":"Delete a contact memory entry","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/native-contacts/{contactId}/memory/{entryId}","href":"/api-reference/native-contacts/delete-a-contact-memory-entry"},{"title":"Cancel a native contact callback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-contacts/{contactId}/callback/cancel","href":"/api-reference/native-contacts/cancel-a-native-contact-callback"}]},{"group":"Native Calendar","icon":"calendar","expanded":false,"pages":[{"title":"Native Calendar API","sidebarTitle":"Overview","href":"/api-reference/native-calendar"},{"title":"List calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/calendars","href":"/api-reference/native-calendar/list-calendars"},{"title":"Create a calendar","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/calendars","href":"/api-reference/native-calendar/create-a-calendar"},{"title":"Preview slots for a calendar definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/calendars/preview","href":"/api-reference/native-calendar/preview-slots-for-a-calendar-definition"},{"title":"Get a calendar","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/calendars/{calendarId}","href":"/api-reference/native-calendar/get-a-calendar"},{"title":"Update a calendar","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/native-calendar/calendars/{calendarId}","href":"/api-reference/native-calendar/update-a-calendar"},{"title":"Delete a calendar","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/native-calendar/calendars/{calendarId}","href":"/api-reference/native-calendar/delete-a-calendar"},{"title":"Get free slots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/calendars/{calendarId}/free-slots","href":"/api-reference/native-calendar/get-free-slots"},{"title":"List appointments for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/appointments","href":"/api-reference/native-calendar/list-appointments-for-a-contact"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/appointments","href":"/api-reference/native-calendar/book-an-appointment"},{"title":"List appointments in a window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/appointments/range","href":"/api-reference/native-calendar/list-appointments-in-a-window"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/appointments/{appointmentId}/cancel","href":"/api-reference/native-calendar/cancel-an-appointment"},{"title":"Confirm an appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/appointments/{appointmentId}/confirm","href":"/api-reference/native-calendar/confirm-an-appointment"},{"title":"Reschedule an appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/appointments/{appointmentId}/reschedule","href":"/api-reference/native-calendar/reschedule-an-appointment"},{"title":"Add an event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/events","href":"/api-reference/native-calendar/add-an-event"},{"title":"List calendar connections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/connections","href":"/api-reference/native-calendar/list-calendar-connections"},{"title":"Connect a calendar system","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/connections/{providerId}/token","href":"/api-reference/native-calendar/connect-a-calendar-system"},{"title":"Disconnect a calendar system","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/native-calendar/connections/{providerId}/disconnect","href":"/api-reference/native-calendar/disconnect-a-calendar-system"},{"title":"List linked calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/providers/{providerId}/calendars","href":"/api-reference/native-calendar/list-linked-calendars"},{"title":"List linked bookings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/native-calendar/providers/{providerId}/appointments","href":"/api-reference/native-calendar/list-linked-bookings"}]},{"group":"Analytics","icon":"chart-column","expanded":false,"pages":[{"title":"Analytics API","sidebarTitle":"Overview","href":"/api-reference/analytics"},{"title":"Get analytics summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/dashboard/analytics","href":"/api-reference/analytics/get-analytics-summary"},{"title":"Get analytics by lead age","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/dashboard/analytics/lead-age","href":"/api-reference/analytics/get-analytics-by-lead-age"},{"title":"Get booking rate by project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/dashboard/booking-rate-by-project","href":"/api-reference/analytics/get-booking-rate-by-project"},{"title":"Get transfer rate by project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/dashboard/transfer-rate-by-project","href":"/api-reference/analytics/get-transfer-rate-by-project"}]},{"group":"Billing","icon":"wallet","expanded":false,"pages":[{"title":"Billing API","sidebarTitle":"Overview","href":"/api-reference/billing"},{"title":"Get billing summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/summary","href":"/api-reference/billing/get-billing-summary"},{"title":"List billing transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/transactions","href":"/api-reference/billing/list-billing-transactions"},{"title":"Get billing usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/usage","href":"/api-reference/billing/get-billing-usage"},{"title":"List billing documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/documents","href":"/api-reference/billing/list-billing-documents"},{"title":"List sub-account wallets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/sub-accounts","href":"/api-reference/billing/list-sub-account-wallets"},{"title":"Get sub-account wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/billing/sub-accounts/{locationId}","href":"/api-reference/billing/get-sub-account-wallet"},{"title":"Update agency auto-recharge","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/billing/auto-recharge","href":"/api-reference/billing/update-agency-auto-recharge"},{"title":"Buy a plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/billing/purchases","href":"/api-reference/billing/buy-a-plan"},{"title":"Update sub-account rebilling","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/billing/sub-accounts/{locationId}/rebilling","href":"/api-reference/billing/update-sub-account-rebilling"},{"title":"Enable rebilling with a charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/billing/sub-accounts/{locationId}/rebilling/enable-with-charge","href":"/api-reference/billing/enable-rebilling-with-a-charge"},{"title":"Charge a sub-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/billing/sub-accounts/{locationId}/charges","href":"/api-reference/billing/charge-a-sub-account"},{"title":"Update sub-account auto-recharge","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/billing/sub-accounts/{locationId}/auto-recharge","href":"/api-reference/billing/update-sub-account-auto-recharge"},{"title":"Update sub-account Credit Guard","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/billing/sub-accounts/{locationId}/credit-guard","href":"/api-reference/billing/update-sub-account-credit-guard"},{"title":"Update Credit Guard for sub-accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/billing/sub-accounts/credit-guard","href":"/api-reference/billing/update-credit-guard-for-sub-accounts"},{"title":"Link a Stripe customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/billing/customer-links","href":"/api-reference/billing/link-a-stripe-customer"},{"title":"Unlink a Stripe customer","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/billing/sub-accounts/{locationId}/customer-link","href":"/api-reference/billing/unlink-a-stripe-customer"}]}]},{"tab":"Changelog","icon":"book","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"TFU Live builder guidance - Team Follow Up API Docs","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":[],"chunks":[]}
