{ "kind": "grist", "name": "Grist", "signIn": "key", "available": true, "connected": true, "account": { "email": "ops@greenleafrealty.in", "name": null }, "lastError": null, "mode": "tool", "runAsync": false, "target": { "doc": "8xQm2KvTzR4pLw", "table": "Site_Visits", "columns": [ "Name", "Phone", "Budget", "Locality", "Visit_Date" ] }, "match": { "column": "Phone", "type": "phone" }, "variableColumns": { "Locality": "locality" }, "tools": [ { "id": "grist_save_row", "title": "Fill in a row", "summary": "Adds or fills the lead's row in your table as the conversation goes.", "writes": true, "enabled": true, "phrases": { "before": null, "after": null } }, { "id": "grist_find_rows", "title": "Look something up", "summary": "Reads rows from your table to answer a question.", "writes": false, "enabled": false, "phrases": { "before": null, "after": null } } ], "toolsInUse": 5, "maxTools": 500, "messages": [ "Every conversation now fills the row that matches Phone." ]}
Tools
Configure Connection
Pin a connection to its target, say how a lead’s row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.
{ "kind": "grist", "name": "Grist", "signIn": "key", "available": true, "connected": true, "account": { "email": "ops@greenleafrealty.in", "name": null }, "lastError": null, "mode": "tool", "runAsync": false, "target": { "doc": "8xQm2KvTzR4pLw", "table": "Site_Visits", "columns": [ "Name", "Phone", "Budget", "Locality", "Visit_Date" ] }, "match": { "column": "Phone", "type": "phone" }, "variableColumns": { "Locality": "locality" }, "tools": [ { "id": "grist_save_row", "title": "Fill in a row", "summary": "Adds or fills the lead's row in your table as the conversation goes.", "writes": true, "enabled": true, "phrases": { "before": null, "after": null } }, { "id": "grist_find_rows", "title": "Look something up", "summary": "Reads rows from your table to answer a question.", "writes": false, "enabled": false, "phrases": { "before": null, "after": null } } ], "toolsInUse": 5, "maxTools": 500, "messages": [ "Every conversation now fills the row that matches Phone." ]}
Authorizations
Authorization
string
header
required
Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.
Headers
Thinnest-Workspace
string
Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.
Example:
"org_3fKq9TzQ1mN8vB2xR7cLpA"
Path Parameters
id
string
required
The agent's id (ag_…).
kind
enum<string>
required
The connection: calcom or calendly (calendars), grist or googlesheets (spreadsheets), zoho, zoho_bigin or hubspot (CRMs), records (kept here), zendesk or salesforce (helpdesks).
Available options:
calcom,
grist,
googlesheets,
zoho,
zoho_bigin,
hubspot,
calendly,
records,
zendesk,
salesforce
Body
application/json
Any of these, as the kind allows. Applied in this order — fields, target, match, variableColumns, mode, runAsync, tools, phrases — stopping at the first refusal; what came before it is kept, and the refusal says so. Helpdesks (zendesk, salesforce) have nothing to configure.
fields
string[]string
Records only: what to collect, Label or Label | what it means.
target
object
Spreadsheets, CRMs and Calendly: pins it and reads the target's real columns. Grist needs doc and table; Google Sheets spreadsheet and sheet; Zoho CRM, Bigin and HubSpot module (HubSpot's is contacts); Calendly eventTypes, the meeting types the agent may book. Use GET …/options to see the choices.
Show child attributes
properties
string[]
HubSpot only: the contact properties the agent fills and searches by (at most 40). Pinning starts from a default pick; this replaces it.
match
object | null
Spreadsheets and CRMs: fill the lead's existing row found by this column instead of adding one. Null (or column: null) adds a row per conversation.
Show child attributes
variableColumns
object
Spreadsheets and CRMs: column to campaign variable, e.g. { "Locality": "locality" }. Neither may contain = or a line break. Replaces the saved map.
Show child attributes
mode
enum<string>
All but the calendar: tool saves during the conversation; parser reads the conversation afterwards (and switches the save tool off).
Available options:
tool,
parser
runAsync
boolean
Grist only: answer before the save finishes.
tools
object
Tool id to true or false. Every id must be one of this connection's tools. Switching on counts against the shared maxTools budget.
Show child attributes
phrases
object
Tool id to { before, after }: what the agent says on a call while the tool runs. Up to 8 lines, each under 60 characters.
Show child attributes
Response
The connection as saved, with what each change said.
One account an agent can work in. Fields beyond the first few depend on the kind: a calendar has timezone; spreadsheets and CRMs have target, match and variableColumns; records has fields, recordCount and link; a helpdesk has only account and enabled. Credentials never appear.
kind
enum<string>
required
The connection.
Available options:
calcom,
grist,
googlesheets,
zoho,
zoho_bigin,
hubspot,
calendly,
records,
zendesk,
salesforce
name
string
required
Its display name.
signIn
enum<string>
required
How it is connected: key by POST with a key; browser through a consent screen in the console (the API cannot); none for records, which need no account.
Available options:
key,
browser,
none
available
boolean
required
Whether this deployment offers it at all.
connected
boolean
required
Whether it is connected.
account
object | null
required
Who it is connected as: { email, name }, or { host, email } for a helpdesk.
Show child attributes
lastError
string | null
required
Why the last attempt to use it failed.
toolsInUse
integer
required
Connection tools switched on, across every connection.
maxTools
integer
required
The shared budget.
messages
string[]
required
What each applied change said, in order.
signInPending
boolean
Browser sign-ins only: a sign-in was started in the console and not finished.
timezone
string | null
Calendar only: the account's timezone.
mode
enum<string>
All but the calendar and helpdesks: tool saves during the conversation; parser reads the conversation afterwards.
Available options:
tool,
parser
runAsync
boolean
Grist only: answer before the save finishes.
target
object
Spreadsheets and CRMs: what it is pinned to, and that target's real columns. Grist { doc, table, columns }; Google Sheets { spreadsheet, sheet, columns }; Zoho { module, columns }.
match
object | null
Spreadsheets and CRMs: the column that finds a lead's existing row, or null to add a row per conversation.
Show child attributes
variableColumns
object
Spreadsheets and CRMs: column to campaign variable.
Show child attributes
tools
object[]
Its tools. Helpdesks have none here.
Show child attributes
fields
object[]
Records only: what is collected.
Show child attributes
recordCount
integer
Records only: how many records have been collected.
link
object | null
Records only: the link to read them. The passcode is shown only by the call that makes a link.
Show child attributes
enabled
boolean
Helpdesks only: whether it is in use.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ThinnestAI","description":"One AI agent that answers on your website, WhatsApp and Telegram — and remembers the same customer across all of them.","colors":{"primary":"#ff4e01","light":"#ff7a3d","dark":"#e64600"},"logo":{"light":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/light.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=b9c83749f4bae8ed15285bc7d2b3dec4","dark":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/dark.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=e25aa9f9221cebcb813fa71c39f72037"},"favicon":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/favicon.png?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=71b74c45d3942ee0cf5d5fec76b24991","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"primary":{"type":"button","label":"Open the console","href":"https://thinnest.ai/app"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"thinnestai","hasAudioNarration":false,"actualSubdomain":"thinnestai","customDomains":["docs.thinnest.ai"],"gitSource":{"type":"github","owner":"ashutoshkaremore","repo":"thin-agents-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b002145a30465d2cf3f4c1f","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":213},{"language":"default","tag":"Documentation","count":59},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Channels","count":14},{"language":"default","tag":"Phone numbers","count":13},{"language":"default","tag":"Your agent","count":12},{"language":"default","tag":"Reaching out","count":10},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Customers","count":9}]},"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/tools/configure-connection","slug":"/api-reference/tools/configure-connection","pageMetadata":{"title":"Configure Connection","description":"Pin a connection to its target, say how a lead's row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/connections/{kind}","href":"/api-reference/tools/configure-connection","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Pin a connection to its target, say how a lead’s row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A \", _jsx(_components.strong, {\n children: \"build\"\n }), \" key may do this.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Configure Connection","description":"Pin a connection to its target, say how a lead's row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/connections/{kind}","href":"/api-reference/tools/configure-connection","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Configure Connection","operationId":"configureConnection","tags":["Tools"],"description":"Pin a connection to its target, say how a lead's row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A **build** key may do this.","requestBody":"7298ab1c-1293-4f90-b3f5-c68b1e9f8fa4","responses":{"200":"5a6c1cd0-79f5-472e-bf5e-94ef3ec4a786","400":"461fb2b7-963a-45e1-a264-08df08b0b752","401":"801f0ed5-2dcc-4d88-b5d7-ba15df59bb2e","403":"0d590b03-9c99-408b-8284-1db47a4e9dd7","404":"2c710d5e-dc4c-49a2-b5c7-bafeca8364eb","409":"d506f2a8-55a0-45d4-af97-540dff1863ec","410":"22520935-a1b6-48a5-abca-ddd29209d40e","429":"6f662494-d3b2-43b9-af95-968e8987d46e","502":"6ddbbd09-28a6-46ca-a295-6e735538589c"},"parameters":["b4d084e2-8b78-47a3-b33d-ac0e142f443c"],"method":"patch","type":"path","servers":["554b68ba-71a0-4ba5-bf79-928576071426"],"security":["2ab51cb1-4826-4aaf-a310-84af0597cd2d"],"path":"/agents/{id}/connections/{kind}","baseUrlOptions":["https://app.thinnest.ai/api/v1"],"title":"Configure Connection","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b4d084e2-8b78-47a3-b33d-ac0e142f443c":{"name":"Thinnest-Workspace","in":"header","required":false,"description":"Developers only: the customer workspace this request acts in — its `org_…` id from `POST /customers`. Leave it out to act in your own workspace. Refused with `404` (`Workspace not found.`) when the id is unknown, is not one of your customers, or is not an `org_…` id; `410` when that customer was deleted (restore it with `POST /customers/{id}/restore` until it is erased); `403` when the key belongs to one customer workspace (it cannot act as another); `400` when your workspace is not a developer workspace. `/customers/*` and `GET /customers/usage` are your own workspace's and refuse the header with `400`: call them without it.","schema":{"type":"string","example":"org_3fKq9TzQ1mN8vB2xR7cLpA","isRequired":false,"description":"Developers only: the customer workspace this request acts in — its `org_…` id from `POST /customers`. Leave it out to act in your own workspace. Refused with `404` (`Workspace not found.`) when the id is unknown, is not one of your customers, or is not an `org_…` id; `410` when that customer was deleted (restore it with `POST /customers/{id}/restore` until it is erased); `403` when the key belongs to one customer workspace (it cannot act as another); `400` when your workspace is not a developer workspace. `/customers/*` and `GET /customers/usage` are your own workspace's and refuse the header with `400`: call them without it.","uniqueKey":"","typeLabel":"string"}},"84f22ef4-b8ab-40c3-aab0-9c49a9450729":{"name":"id","in":"path","required":true,"description":"The agent's id (`ag_…`).","schema":{"type":"string","isRequired":true,"description":"The agent's id (`ag_…`).","uniqueKey":"","typeLabel":"string"},"example":"ag_3f6a9c21-7d4e-4b58-9a1f-0c2e8b7d5a34"},"a9cc5ad8-f345-4902-9063-ca0f67e6e5f7":{"name":"kind","in":"path","required":true,"description":"The connection: `calcom` or `calendly` (calendars), `grist` or `googlesheets` (spreadsheets), `zoho`, `zoho_bigin` or `hubspot` (CRMs), `records` (kept here), `zendesk` or `salesforce` (helpdesks).","schema":{"type":"string","enum":["calcom","grist","googlesheets","zoho","zoho_bigin","hubspot","calendly","records","zendesk","salesforce"],"isRequired":true,"description":"The connection: `calcom` or `calendly` (calendars), `grist` or `googlesheets` (spreadsheets), `zoho`, `zoho_bigin` or `hubspot` (CRMs), `records` (kept here), `zendesk` or `salesforce` (helpdesks).","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"grist"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Any of these, as the kind allows. Applied in this order — fields, target, match, variableColumns, mode, runAsync, tools, phrases — stopping at the first refusal; what came before it is kept, and the refusal says so. Helpdesks (`zendesk`, `salesforce`) have nothing to configure.","properties":{"fields":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"fields.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Records only: what to collect, `Label` or `Label | what it means`.","uniqueKey":"fields.oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Records only: what to collect, `Label` or `Label | what it means`.","uniqueKey":"fields.oneOf.1","typeLabel":"string"}],"uniqueKey":"fields","typeLabel":"string[] | string"},"target":{"type":"object","description":"Spreadsheets, CRMs and Calendly: pins it and reads the target's real columns. Grist needs `doc` and `table`; Google Sheets `spreadsheet` and `sheet`; Zoho CRM, Bigin and HubSpot `module` (HubSpot's is `contacts`); Calendly `eventTypes`, the meeting types the agent may book. Use `GET …/options` to see the choices.","properties":{"doc":{"type":"string","description":"Grist: the document id.","uniqueKey":"target.doc","typeLabel":"string"},"table":{"type":"string","description":"Grist: the table id.","uniqueKey":"target.table","typeLabel":"string"},"spreadsheet":{"type":"string","description":"Google Sheets: the spreadsheet id or link.","uniqueKey":"target.spreadsheet","typeLabel":"string"},"sheet":{"type":"string","description":"Google Sheets: the sheet (tab) name.","uniqueKey":"target.sheet","typeLabel":"string"},"module":{"type":"string","description":"Zoho: the module's API name, e.g. `Leads`. HubSpot: `contacts`.","uniqueKey":"target.module","typeLabel":"string"},"eventTypes":{"type":"array","items":{"type":"string","uniqueKey":"target.eventTypes.items.[INDEX]","typeLabel":"string"},"description":"Calendly: the meeting type URIs the agent may book, from `GET …/options`.","uniqueKey":"target.eventTypes","typeLabel":"string[]"}},"uniqueKey":"target","typeLabel":"object"},"properties":{"type":"array","items":{"type":"string","uniqueKey":"properties.items.[INDEX]","typeLabel":"string"},"description":"HubSpot only: the contact properties the agent fills and searches by (at most 40). Pinning starts from a default pick; this replaces it.","uniqueKey":"properties","typeLabel":"string[]"},"match":{"oneOf":[{"type":"object","description":"Spreadsheets and CRMs: fill the lead's existing row found by this column instead of adding one. Null (or `column: null`) adds a row per conversation.","properties":{"column":{"oneOf":[{"type":"string","description":"A column of the pinned target.","uniqueKey":"match.oneOf.0.column.oneOf.0","typeLabel":"string"},{"type":"null","description":"A column of the pinned target.","uniqueKey":"match.oneOf.0.column.oneOf.1","typeLabel":"null"}],"uniqueKey":"match.oneOf.0.column","typeLabel":"string | null"},"type":{"type":"string","description":"`phone` compares numbers loosely; `exact` compares text exactly.","enum":["phone","exact"],"default":"phone","uniqueKey":"match.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"match.oneOf.0","typeLabel":"object"},{"type":"null","description":"Spreadsheets and CRMs: fill the lead's existing row found by this column instead of adding one. Null (or `column: null`) adds a row per conversation.","properties":{"column":{"oneOf":[{"type":"string","description":"A column of the pinned target."},{"type":"null","description":"A column of the pinned target."}]},"type":{"type":"string","description":"`phone` compares numbers loosely; `exact` compares text exactly.","enum":["phone","exact"],"default":"phone"}},"uniqueKey":"match.oneOf.1","typeLabel":"null"}],"uniqueKey":"match","typeLabel":"object | null"},"variableColumns":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"variableColumns.additionalProperties","typeLabel":"string"},"description":"Spreadsheets and CRMs: column to campaign variable, e.g. `{ \"Locality\": \"locality\" }`. Neither may contain `=` or a line break. Replaces the saved map.","uniqueKey":"variableColumns","typeLabel":"object"},"mode":{"type":"string","description":"All but the calendar: `tool` saves during the conversation; `parser` reads the conversation afterwards (and switches the save tool off).","enum":["tool","parser"],"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"runAsync":{"type":"boolean","description":"Grist only: answer before the save finishes.","uniqueKey":"runAsync","typeLabel":"boolean"},"tools":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"tools.additionalProperties","typeLabel":"boolean"},"description":"Tool id to `true` or `false`. Every id must be one of this connection's tools. Switching on counts against the shared `maxTools` budget.","uniqueKey":"tools","typeLabel":"object"},"phrases":{"type":"object","description":"Tool id to `{ before, after }`: what the agent says on a call while the tool runs. Up to 8 lines, each under 60 characters.","additionalProperties":{"type":"object","properties":{"before":{"oneOf":[{"type":"string","description":"Said while it waits.","uniqueKey":"phrases.additionalProperties.before.oneOf.0","typeLabel":"string"},{"type":"null","description":"Said while it waits.","uniqueKey":"phrases.additionalProperties.before.oneOf.1","typeLabel":"null"}],"uniqueKey":"phrases.additionalProperties.before","typeLabel":"string | null"},"after":{"oneOf":[{"type":"string","description":"Said after.","uniqueKey":"phrases.additionalProperties.after.oneOf.0","typeLabel":"string"},{"type":"null","description":"Said after.","uniqueKey":"phrases.additionalProperties.after.oneOf.1","typeLabel":"null"}],"uniqueKey":"phrases.additionalProperties.after","typeLabel":"string | null"}},"uniqueKey":"phrases.additionalProperties","typeLabel":"object"},"uniqueKey":"phrases","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"calcom":{"title":"calcom","summary":"calcom","value":{"tools":{"calcom_check_availability":true,"calcom_book_meeting":true},"phrases":{"calcom_check_availability":{"before":"Let me look at the calendar.","after":null}}}},"grist":{"title":"grist","summary":"grist","value":{"target":{"doc":"8xQm2KvTzR4pLw","table":"Site_Visits"},"match":{"column":"Phone","type":"phone"},"variableColumns":{"Locality":"locality"},"mode":"tool","runAsync":false,"tools":{"grist_save_row":true}}},"googlesheets":{"title":"googlesheets","summary":"googlesheets","value":{"target":{"spreadsheet":"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms","sheet":"Leads"},"match":{"column":"Mobile","type":"phone"},"tools":{"GOOGLESHEETS_LOOKUP_SPREADSHEET_ROW":true}}},"zoho":{"title":"zoho","summary":"zoho","value":{"target":{"module":"Leads"},"match":{"column":"Mobile","type":"phone"},"mode":"tool","tools":{"zoho_save_lead":true,"zoho_find_lead":true}}},"zoho_bigin":{"title":"zoho_bigin","summary":"zoho_bigin","value":{"target":{"module":"Contacts"},"tools":{"bigin_save_contact":true}}},"hubspot":{"title":"hubspot","summary":"hubspot","value":{"target":{"module":"contacts"},"properties":["firstname","lastname","email","phone","hs_lead_status"],"match":{"column":"phone","type":"phone"},"tools":{"hubspot_save_contact":true,"hubspot_find_contact":true}}},"calendly":{"title":"calendly","summary":"calendly","value":{"target":{"eventTypes":["https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA"]},"tools":{"calendly_check_availability":true,"calendly_book_meeting":true}}},"records":{"title":"records","summary":"records","value":{"fields":["Name","City | where they live","Budget | in lakhs","Visit date"],"mode":"tool","tools":{"record_save_row":true}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5a6c1cd0-79f5-472e-bf5e-94ef3ec4a786":{"description":"The connection as saved, with what each change said.","content":{"application/json":{"schema":{"type":"object","description":"One account an agent can work in. Fields beyond the first few depend on the kind: a calendar has `timezone`; spreadsheets and CRMs have `target`, `match` and `variableColumns`; records has `fields`, `recordCount` and `link`; a helpdesk has only `account` and `enabled`. Credentials never appear.","required":["messages","toolsInUse","maxTools","kind","name","signIn","available","connected","account","lastError"],"properties":{"kind":{"type":"string","description":"The connection.","enum":["calcom","grist","googlesheets","zoho","zoho_bigin","hubspot","calendly","records","zendesk","salesforce"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Its display name.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"signIn":{"type":"string","description":"How it is connected: `key` by `POST` with a key; `browser` through a consent screen in the console (the API cannot); `none` for records, which need no account.","enum":["key","browser","none"],"isRequired":true,"uniqueKey":"signIn","typeLabel":"enum\u003cstring>"},"available":{"type":"boolean","description":"Whether this deployment offers it at all.","isRequired":true,"uniqueKey":"available","typeLabel":"boolean"},"connected":{"type":"boolean","description":"Whether it is connected.","isRequired":true,"uniqueKey":"connected","typeLabel":"boolean"},"account":{"oneOf":[{"type":"object","description":"Who it is connected as: `{ email, name }`, or `{ host, email }` for a helpdesk.","properties":{"email":{"oneOf":[{"type":"string","description":"The account's email.","uniqueKey":"account.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The account's email.","uniqueKey":"account.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.oneOf.0.email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The account's name.","uniqueKey":"account.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The account's name.","uniqueKey":"account.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.oneOf.0.name","typeLabel":"string | null"},"host":{"type":"string","description":"The helpdesk's host.","uniqueKey":"account.oneOf.0.host","typeLabel":"string"}},"isRequired":true,"uniqueKey":"account.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who it is connected as: `{ email, name }`, or `{ host, email }` for a helpdesk.","properties":{"email":{"oneOf":[{"type":"string","description":"The account's email."},{"type":"null","description":"The account's email."}]},"name":{"oneOf":[{"type":"string","description":"The account's name."},{"type":"null","description":"The account's name."}]},"host":{"type":"string","description":"The helpdesk's host."}},"isRequired":true,"uniqueKey":"account.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"account","typeLabel":"object | null"},"lastError":{"oneOf":[{"type":"string","description":"Why the last attempt to use it failed.","isRequired":true,"uniqueKey":"lastError.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the last attempt to use it failed.","isRequired":true,"uniqueKey":"lastError.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lastError","typeLabel":"string | null"},"toolsInUse":{"type":"integer","description":"Connection tools switched on, across every connection.","isRequired":true,"uniqueKey":"toolsInUse","typeLabel":"integer"},"maxTools":{"type":"integer","description":"The shared budget.","isRequired":true,"uniqueKey":"maxTools","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX]","typeLabel":"string"},"description":"What each applied change said, in order.","isRequired":true,"uniqueKey":"messages","typeLabel":"string[]"},"signInPending":{"type":"boolean","description":"Browser sign-ins only: a sign-in was started in the console and not finished.","uniqueKey":"signInPending","typeLabel":"boolean"},"timezone":{"oneOf":[{"type":"string","description":"Calendar only: the account's timezone.","uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Calendar only: the account's timezone.","uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"timezone","typeLabel":"string | null"},"mode":{"type":"string","description":"All but the calendar and helpdesks: `tool` saves during the conversation; `parser` reads the conversation afterwards.","enum":["tool","parser"],"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"runAsync":{"type":"boolean","description":"Grist only: answer before the save finishes.","uniqueKey":"runAsync","typeLabel":"boolean"},"target":{"type":"object","description":"Spreadsheets and CRMs: what it is pinned to, and that target's real columns. Grist `{ doc, table, columns }`; Google Sheets `{ spreadsheet, sheet, columns }`; Zoho `{ module, columns }`.","additionalProperties":true,"uniqueKey":"target","typeLabel":"object"},"match":{"oneOf":[{"type":"object","description":"Spreadsheets and CRMs: the column that finds a lead's existing row, or null to add a row per conversation.","properties":{"column":{"type":"string","description":"The column.","uniqueKey":"match.oneOf.0.column","typeLabel":"string"},"type":{"type":"string","description":"How it is compared.","enum":["phone","exact"],"uniqueKey":"match.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"match.oneOf.0","typeLabel":"object"},{"type":"null","description":"Spreadsheets and CRMs: the column that finds a lead's existing row, or null to add a row per conversation.","properties":{"column":{"type":"string","description":"The column."},"type":{"type":"string","description":"How it is compared.","enum":["phone","exact"]}},"uniqueKey":"match.oneOf.1","typeLabel":"null"}],"uniqueKey":"match","typeLabel":"object | null"},"variableColumns":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"variableColumns.additionalProperties","typeLabel":"string"},"description":"Spreadsheets and CRMs: column to campaign variable.","uniqueKey":"variableColumns","typeLabel":"object"},"tools":{"type":"array","description":"Its tools. Helpdesks have none here.","items":{"type":"object","required":["id","title","summary","writes","enabled","phrases"],"properties":{"id":{"type":"string","description":"The tool's id, used as the key in `PATCH` `tools` and `phrases`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","description":"Its name in the console.","isRequired":true,"uniqueKey":"tools.items.[INDEX].title","typeLabel":"string"},"summary":{"type":"string","description":"What it does.","isRequired":true,"uniqueKey":"tools.items.[INDEX].summary","typeLabel":"string"},"writes":{"type":"boolean","description":"Whether calling it changes something in the account.","isRequired":true,"uniqueKey":"tools.items.[INDEX].writes","typeLabel":"boolean"},"enabled":{"type":"boolean","description":"Whether it is switched on. Every tool starts off.","isRequired":true,"uniqueKey":"tools.items.[INDEX].enabled","typeLabel":"boolean"},"phrases":{"type":"object","description":"On calls, what the agent says while the tool runs.","properties":{"before":{"oneOf":[{"type":"string","description":"Said while it waits; one phrase per line.","uniqueKey":"tools.items.[INDEX].phrases.before.oneOf.0","typeLabel":"string"},{"type":"null","description":"Said while it waits; one phrase per line.","uniqueKey":"tools.items.[INDEX].phrases.before.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].phrases.before","typeLabel":"string | null"},"after":{"oneOf":[{"type":"string","description":"Said after it answers.","uniqueKey":"tools.items.[INDEX].phrases.after.oneOf.0","typeLabel":"string"},{"type":"null","description":"Said after it answers.","uniqueKey":"tools.items.[INDEX].phrases.after.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].phrases.after","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"tools.items.[INDEX].phrases","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tools","typeLabel":"object[]"},"fields":{"type":"array","description":"Records only: what is collected.","items":{"type":"object","properties":{"id":{"type":"string","description":"The field's id.","uniqueKey":"fields.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","description":"Its label.","uniqueKey":"fields.items.[INDEX].label","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"What it means, if given.","uniqueKey":"fields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"What it means, if given.","uniqueKey":"fields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.items.[INDEX].description","typeLabel":"string | null"}},"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"},"recordCount":{"type":"integer","description":"Records only: how many records have been collected.","uniqueKey":"recordCount","typeLabel":"integer"},"link":{"oneOf":[{"type":"object","description":"Records only: the link to read them. The passcode is shown only by the call that makes a link.","properties":{"url":{"type":"string","description":"The link.","uniqueKey":"link.oneOf.0.url","typeLabel":"string"},"hasPasscode":{"type":"boolean","description":"Always true: the link needs its passcode.","uniqueKey":"link.oneOf.0.hasPasscode","typeLabel":"boolean"},"passcode":{"type":"string","description":"Only in the response that made the link — never again.","uniqueKey":"link.oneOf.0.passcode","typeLabel":"string"}},"uniqueKey":"link.oneOf.0","typeLabel":"object"},{"type":"null","description":"Records only: the link to read them. The passcode is shown only by the call that makes a link.","properties":{"url":{"type":"string","description":"The link."},"hasPasscode":{"type":"boolean","description":"Always true: the link needs its passcode."},"passcode":{"type":"string","description":"Only in the response that made the link — never again."}},"uniqueKey":"link.oneOf.1","typeLabel":"null"}],"uniqueKey":"link","typeLabel":"object | null"},"enabled":{"type":"boolean","description":"Helpdesks only: whether it is in use.","uniqueKey":"enabled","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"kind":"grist","name":"Grist","signIn":"key","available":true,"connected":true,"account":{"email":"ops@greenleafrealty.in","name":null},"lastError":null,"mode":"tool","runAsync":false,"target":{"doc":"8xQm2KvTzR4pLw","table":"Site_Visits","columns":["Name","Phone","Budget","Locality","Visit_Date"]},"match":{"column":"Phone","type":"phone"},"variableColumns":{"Locality":"locality"},"tools":[{"id":"grist_save_row","title":"Fill in a row","summary":"Adds or fills the lead's row in your table as the conversation goes.","writes":true,"enabled":true,"phrases":{"before":null,"after":null}},{"id":"grist_find_rows","title":"Look something up","summary":"Reads rows from your table to answer a question.","writes":false,"enabled":false,"phrases":{"before":null,"after":null}}],"toolsInUse":5,"maxTools":500,"messages":["Every conversation now fills the row that matches Phone."]},"examples":{"Example":{"title":"Example","value":{"kind":"grist","name":"Grist","signIn":"key","available":true,"connected":true,"account":{"email":"ops@greenleafrealty.in","name":null},"lastError":null,"mode":"tool","runAsync":false,"target":{"doc":"8xQm2KvTzR4pLw","table":"Site_Visits","columns":["Name","Phone","Budget","Locality","Visit_Date"]},"match":{"column":"Phone","type":"phone"},"variableColumns":{"Locality":"locality"},"tools":[{"id":"grist_save_row","title":"Fill in a row","summary":"Adds or fills the lead's row in your table as the conversation goes.","writes":true,"enabled":true,"phrases":{"before":null,"after":null}},{"id":"grist_find_rows","title":"Look something up","summary":"Reads rows from your table to answer a question.","writes":false,"enabled":false,"phrases":{"before":null,"after":null}}],"toolsInUse":5,"maxTools":500,"messages":["Every conversation now fills the row that matches Phone."]}}},"exampleType":"examples"}},"exampleType":"examples"},"461fb2b7-963a-45e1-a264-08df08b0b752":{"description":"A field is wrong for this kind, or the provider refused it.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"helpdesk":{"title":"helpdesk","summary":"Helpdesk","value":{"error":"A helpdesk has nothing to configure — POST to reconnect it, or DELETE to disconnect."}},"target":{"title":"target","summary":"Incomplete target","value":{"error":"`target` needs `doc` and `table`."}},"tool":{"title":"tool","summary":"Not this connection's tool","value":{"error":"`zoho_save_lead` is not one of this connection's tools."}},"column":{"title":"column","summary":"Unknown column","value":{"error":"That column is not in the table any more. Choose the table again."}},"empty":{"title":"empty","summary":"Empty body","value":{"error":"Nothing to change — the body named no field this connection takes."}}},"exampleType":"examples"}},"exampleType":"examples"},"801f0ed5-2dcc-4d88-b5d7-ba15df59bb2e":{"description":"The key is missing, wrong or revoked. The answer is always the same, whichever it is.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized","code":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","code":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"0d590b03-9c99-408b-8284-1db47a4e9dd7":{"description":"The key's access level (read-only or build) does not allow this request, the plan does not include it, or a customer's key named another workspace in `Thinnest-Workspace`. `code` says which: `key_scope_read`, `key_scope_build`, `workspace_header_forbidden`, or `forbidden`.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"readOnlyKey":{"title":"readOnlyKey","summary":"A read-only key tried to change something","value":{"error":"This API key is read-only. Use a build or full key to change anything.","code":"key_scope_read"}},"buildKey":{"title":"buildKey","summary":"A build key tried to message customers, send codes or place calls","value":{"error":"This API key is a build key: it can set up agents, actions, contacts and webhooks, but not message customers, send codes or place calls. Use a full key for that.","code":"key_scope_build"}},"customerKey":{"title":"customerKey","summary":"A customer's key named another workspace","value":{"error":"This key belongs to one customer workspace and cannot act as another.","code":"workspace_header_forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"2c710d5e-dc4c-49a2-b5c7-bafeca8364eb":{"description":"The agent is not in this workspace, or `kind` is not a connection.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"agent":{"title":"agent","summary":"Agent","value":{"error":"That agent was not found."}},"kind":{"title":"kind","summary":"Kind","value":{"error":"That kind of connection was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"d506f2a8-55a0-45d4-af97-540dff1863ec":{"description":"Not connected yet, a target is needed first, or the tool budget is spent.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"browser":{"title":"browser","summary":"Browser sign-in needed","value":{"error":"Sign in to that account in the console first."}},"connect":{"title":"connect","summary":"Not connected","value":{"error":"Connect that account first."}},"table":{"title":"table","summary":"No table","value":{"error":"Choose a table first."}},"budget":{"title":"budget","summary":"Budget spent","value":{"error":"An agent can have 500 connected tools at once, across all your connections. Turn one off to make room — every extra tool makes the agent worse at choosing between them."}}},"exampleType":"examples"}},"exampleType":"examples"},"22520935-a1b6-48a5-abca-ddd29209d40e":{"description":"The customer named in `Thinnest-Workspace` was deleted. `POST /customers/{id}/restore` brings it back until its erase date.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"This workspace was deleted on 2026-10-06 and is erased on 2026-11-05. POST /v1/customers/{id}/restore brings it back until then.","code":"workspace_deleted"},"examples":{"Example":{"title":"Example","value":{"error":"This workspace was deleted on 2026-10-06 and is erased on 2026-11-05. POST /v1/customers/{id}/restore brings it back until then.","code":"workspace_deleted"}}},"exampleType":"examples"}},"exampleType":"examples"},"6f662494-d3b2-43b9-af95-968e8987d46e":{"description":"Over a per-minute limit. Wait for `Retry-After` seconds. `code` and `limit` say which limit: `rate_limit_resources` (240 requests a minute for the workspace), `rate_limit_family` (2,400 across a developer's customers), `rate_limit_calls`, `rate_limit_messages`, `rate_limit_codes`, `rate_limit_code_recipient`, `concurrent_calls` or `number_daily_limit`.","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}},"content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Over 240 requests a minute. Slow down and retry.","code":"rate_limit_resources","limit":{"name":"resources","perMinute":240}},"examples":{"Example":{"title":"Example","value":{"error":"Over 240 requests a minute. Slow down and retry.","code":"rate_limit_resources","limit":{"name":"resources","perMinute":240}}}},"exampleType":"examples"}},"exampleType":"examples"},"6ddbbd09-28a6-46ca-a295-6e735538589c":{"description":"The account could not be read.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Could not read that sheet's header row: permission denied."},"examples":{"Example":{"title":"Example","value":{"error":"Could not read that sheet's header row: permission denied."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2ab51cb1-4826-4aaf-a310-84af0597cd2d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"554b68ba-71a0-4ba5-bf79-928576071426":{"url":"https://app.thinnest.ai/api/v1","description":"Every workspace, in every country"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"thinnestai","siteName":"ThinnestAI","title":"Configure Connection - ThinnestAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T05:30:11.392Z","originalFileLocation":"api-reference/tools/configure-connection.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=\"Pin a connection to its target, say how a lead\u0026#x27;s row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ThinnestAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Configure Connection - ThinnestAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pin a connection to its target, say how a lead\u0026#x27;s row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ThinnestAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.thinnest.ai/api-reference/tools/configure-connection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://thinnestai.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Configure+Connection\u0026amp;description=Pin+a+connection+to+its+target%2C+say+how+a+lead%27s+row+is+found%2C+choose+when+it+saves%2C+and+switch+its+tools.+The+account+must+be+connected+first+%28records+excepted\u0026amp;theme=d7927b3e8113ef719ec01f55\u0026amp;signature=20e8de0a81d65ae821f4aae94758e2fa1539924226304073205e1a494ec692c4\">\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=\"Configure Connection - ThinnestAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pin a connection to its target, say how a lead\u0026#x27;s row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://thinnestai.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Configure+Connection\u0026amp;description=Pin+a+connection+to+its+target%2C+say+how+a+lead%27s+row+is+found%2C+choose+when+it+saves%2C+and+switch+its+tools.+The+account+must+be+connected+first+%28records+excepted\u0026amp;theme=d7927b3e8113ef719ec01f55\u0026amp;signature=20e8de0a81d65ae821f4aae94758e2fa1539924226304073205e1a494ec692c4\">\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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ThinnestAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff4e01\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.thinnest.ai/api-reference/tools/configure-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tools/configure-connection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.thinnest.ai/#organization\",\"name\":\"ThinnestAI\",\"url\":\"https://docs.thinnest.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/light.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=b9c83749f4bae8ed15285bc7d2b3dec4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.thinnest.ai#website\",\"name\":\"ThinnestAI\",\"url\":\"https://docs.thinnest.ai\",\"publisher\":{\"@id\":\"https://docs.thinnest.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection#webpage\",\"url\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection\",\"name\":\"Configure Connection\",\"description\":\"Pin a connection to its target, say how a lead's row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.\",\"dateModified\":\"2026-11-10T05:30:11.392Z\",\"isPartOf\":{\"@id\":\"https://docs.thinnest.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://docs.thinnest.ai/api-reference/tools/list-built-in-tools\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Configure Connection\",\"item\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection#apireference\",\"headline\":\"Configure Connection\",\"name\":\"Configure Connection\",\"description\":\"Pin a connection to its target, say how a lead's row is found, choose when it saves, and switch its tools. The account must be connected first (records excepted). Changes apply in a fixed order and stop at the first refusal, keeping what came before it. Helpdesks have nothing to configure. A build key may do this.\",\"url\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.thinnest.ai/api-reference/tools/configure-connection#webpage\"},\"dateModified\":\"2026-11-10T05:30:11.392Z\",\"publisher\":{\"@id\":\"https://docs.thinnest.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.thinnest.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ThinnestAI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ThinnestAI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tools/configure-connection.md","siteName":"ThinnestAI","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"SDKs","href":"/api-reference/sdks"},{"title":"Customers","href":"/api-reference/customers"},{"title":"Bring your own keys","href":"/api-reference/bring-your-own-keys"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Agents","pages":[{"title":"List Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/agents/update-agent"},{"title":"Delete Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Get Agent BYOK Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/byok-model","href":"/api-reference/agents/get-agent-byok-model"},{"title":"Set Agent BYOK Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}/byok-model","href":"/api-reference/agents/set-agent-byok-model"},{"title":"Get Agent BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/byok-voice","href":"/api-reference/agents/get-agent-byok-voice"},{"title":"Set Agent BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}/byok-voice","href":"/api-reference/agents/set-agent-byok-voice"},{"title":"Test Chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/test-chat","href":"/api-reference/agents/test-chat"}]},{"group":"Knowledge","pages":[{"title":"List Knowledge Documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/knowledge","href":"/api-reference/knowledge/list-knowledge-documents"},{"title":"Add Knowledge Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/knowledge","href":"/api-reference/knowledge/add-knowledge-document"},{"title":"Delete Knowledge Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/knowledge/{documentId}","href":"/api-reference/knowledge/delete-knowledge-document"}]},{"group":"Actions","pages":[{"title":"List Actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/actions","href":"/api-reference/actions/list-actions"},{"title":"Create Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/actions","href":"/api-reference/actions/create-action"},{"title":"Get Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/actions/{actionId}","href":"/api-reference/actions/get-action"},{"title":"Update Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/actions/{actionId}","href":"/api-reference/actions/update-action"},{"title":"Delete Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/actions/{actionId}","href":"/api-reference/actions/delete-action"},{"title":"Test Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/actions/{actionId}/test","href":"/api-reference/actions/test-action"}]},{"group":"Tools","pages":[{"title":"List Built-in Tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/tools","href":"/api-reference/tools/list-built-in-tools"},{"title":"Update Built-in Tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/tools","href":"/api-reference/tools/update-built-in-tools"},{"title":"List Tool Servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/mcp-servers","href":"/api-reference/tools/list-tool-servers"},{"title":"Connect Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/mcp-servers","href":"/api-reference/tools/connect-tool-server"},{"title":"Get Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/mcp-servers/{serverId}","href":"/api-reference/tools/get-tool-server"},{"title":"Disconnect Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/mcp-servers/{serverId}","href":"/api-reference/tools/disconnect-tool-server"},{"title":"Sync Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/mcp-servers/{serverId}/sync","href":"/api-reference/tools/sync-tool-server"},{"title":"Update Tool Server Tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/mcp-servers/{serverId}/tools/{toolId}","href":"/api-reference/tools/update-tool-server-tool"},{"title":"List Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections","href":"/api-reference/tools/list-connections"},{"title":"Get Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections/{kind}","href":"/api-reference/tools/get-connection"},{"title":"Connect Account","description":"Connect (or re-key) an account. Every key, token and secret is sealed and never returned. Connecting grants nothing: tools start off and are switched with `PATCH` `tools`. `googlesheets`, `zoho`, `zoho_bigin`, `hubspot` and `calendly` sign in on the provider's own consent screen — connect them once in the console (this answers `409`), then configure them here. A helpdesk connect opens one test ticket or case and answers with `inbound` **once**; a records connect that makes the first link answers with `link.passcode` **once**. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/connections/{kind}","href":"/api-reference/tools/connect-account"},{"title":"Configure Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/connections/{kind}","href":"/api-reference/tools/configure-connection"},{"title":"Disconnect Account","description":"Disconnect the account; its tools leave the agent and its credential is deleted. A browser sign-in still pending is cancelled too. What already happened in the account (meetings booked, rows written) is untouched, and records already collected are kept. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/connections/{kind}","href":"/api-reference/tools/disconnect-account"},{"title":"List Connection Options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections/{kind}/options","href":"/api-reference/tools/list-connection-options"},{"title":"Replace Records Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/connections/records/link","href":"/api-reference/tools/replace-records-link"}]},{"group":"Channels","pages":[{"title":"Get Agent Channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/channels","href":"/api-reference/channels/get-agent-channels"},{"title":"Connect Telegram Bot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/channels/telegram","href":"/api-reference/channels/connect-telegram-bot"},{"title":"Disconnect Telegram Bot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/channels/telegram","href":"/api-reference/channels/disconnect-telegram-bot"}]},{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Place Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls","href":"/api-reference/calls/place-call"},{"title":"Place Batch Calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/batch","href":"/api-reference/calls/place-batch-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}","href":"/api-reference/calls/get-call"},{"title":"Cancel Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /calls/{id}","href":"/api-reference/calls/cancel-call"},{"title":"Get Call Transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/transcript","href":"/api-reference/calls/get-call-transcript"},{"title":"Get Call Timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/timeline","href":"/api-reference/calls/get-call-timeline"}]},{"group":"Post-call","pages":[{"title":"Get Call Analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/analysis","href":"/api-reference/post-call/get-call-analysis"},{"title":"Delete Call Content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /calls/{id}/content","href":"/api-reference/post-call/delete-call-content"},{"title":"Get Post-call Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/post-call","href":"/api-reference/post-call/get-post-call-settings"},{"title":"Update Post-call Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/post-call","href":"/api-reference/post-call/update-post-call-settings"}]},{"group":"Recordings","pages":[{"title":"Get Call Recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/recording","href":"/api-reference/recordings/get-call-recording"},{"title":"Get Recording By Signed Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /recordings/{callId}","href":"/api-reference/recordings/get-recording-by-signed-link"}]},{"group":"Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"List Conversation Messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{id}/messages","href":"/api-reference/conversations/list-conversation-messages"},{"title":"Reply to Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/reply","href":"/api-reference/conversations/reply-to-conversation"},{"title":"Update Conversation Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/status","href":"/api-reference/conversations/update-conversation-status"},{"title":"Assign Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/assign","href":"/api-reference/conversations/assign-conversation"}]},{"group":"Messages","pages":[{"title":"Send Message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /messages","href":"/api-reference/messages/send-message"}]},{"group":"One-time codes","pages":[{"title":"Send One-Time Code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes","href":"/api-reference/one-time-codes/send-one-time-code"},{"title":"List Code Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /codes/templates","href":"/api-reference/one-time-codes/list-code-templates"},{"title":"Create Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes/templates","href":"/api-reference/one-time-codes/create-code-template"},{"title":"Get Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /codes/templates/{id}","href":"/api-reference/one-time-codes/get-code-template"},{"title":"Update Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /codes/templates/{id}","href":"/api-reference/one-time-codes/update-code-template"},{"title":"Delete Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /codes/templates/{id}","href":"/api-reference/one-time-codes/delete-code-template"},{"title":"Submit Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes/templates/{id}/submit","href":"/api-reference/one-time-codes/submit-code-template"}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/{id}","href":"/api-reference/contacts/get-contact"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contacts/{id}","href":"/api-reference/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/{id}","href":"/api-reference/contacts/delete-contact"}]},{"group":"Do not call","pages":[{"title":"List Do-Not-Call Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /do-not-call","href":"/api-reference/do-not-call/list-do-not-call-numbers"},{"title":"Add Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /do-not-call","href":"/api-reference/do-not-call/add-do-not-call-number"},{"title":"Get Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /do-not-call/{phone}","href":"/api-reference/do-not-call/get-do-not-call-number"},{"title":"Remove Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /do-not-call/{phone}","href":"/api-reference/do-not-call/remove-do-not-call-number"}]},{"group":"Events","pages":[{"title":"Report Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /events","href":"/api-reference/events/report-event"}]},{"group":"Templates","pages":[{"title":"List Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates","href":"/api-reference/templates/list-templates"},{"title":"Create Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates","href":"/api-reference/templates/create-template"},{"title":"Get Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates/{name}","href":"/api-reference/templates/get-template"},{"title":"Update Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /templates/{name}","href":"/api-reference/templates/update-template"},{"title":"Delete Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /templates/{name}","href":"/api-reference/templates/delete-template"},{"title":"Submit Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates/{name}/submit","href":"/api-reference/templates/submit-template"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Launch Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/launch","href":"/api-reference/campaigns/launch-campaign"},{"title":"Pause Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Resume Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/resume","href":"/api-reference/campaigns/resume-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/cancel","href":"/api-reference/campaigns/cancel-campaign"}]},{"group":"Sequences","pages":[{"title":"List Sequences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences","href":"/api-reference/sequences/list-sequences"},{"title":"Create Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences","href":"/api-reference/sequences/create-sequence"},{"title":"Get Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{sequenceId}","href":"/api-reference/sequences/get-sequence"},{"title":"Update Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /sequences/{sequenceId}","href":"/api-reference/sequences/update-sequence"},{"title":"Delete Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sequences/{sequenceId}","href":"/api-reference/sequences/delete-sequence"},{"title":"Add Sequence Step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/steps","href":"/api-reference/sequences/add-sequence-step"},{"title":"Activate Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/activate","href":"/api-reference/sequences/activate-sequence"},{"title":"Pause Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/pause","href":"/api-reference/sequences/pause-sequence"},{"title":"Enrol in Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/enrolments","href":"/api-reference/sequences/enrol-in-sequence"}]},{"group":"Forms","pages":[{"title":"List Forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /forms","href":"/api-reference/forms/list-forms"},{"title":"Create Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /forms","href":"/api-reference/forms/create-form"},{"title":"Get Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /forms/{id}","href":"/api-reference/forms/get-form"},{"title":"Update Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /forms/{id}","href":"/api-reference/forms/update-form"},{"title":"Delete Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /forms/{id}","href":"/api-reference/forms/delete-form"},{"title":"Publish Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /forms/{id}/publish","href":"/api-reference/forms/publish-form"}]},{"group":"Phone numbers","pages":[{"title":"List Phone Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Rent Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers","href":"/api-reference/phone-numbers/rent-phone-number"},{"title":"Get Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/{number}","href":"/api-reference/phone-numbers/get-phone-number"},{"title":"Update Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /phone-numbers/{number}","href":"/api-reference/phone-numbers/update-phone-number"},{"title":"Release Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /phone-numbers/{number}","href":"/api-reference/phone-numbers/release-phone-number"},{"title":"Move Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/{number}/move","href":"/api-reference/phone-numbers/move-phone-number"},{"title":"Get Business Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/business-details","href":"/api-reference/phone-numbers/get-business-details"},{"title":"Send Business Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /phone-numbers/business-details","href":"/api-reference/phone-numbers/send-business-details"},{"title":"Search Available Phone Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/available","href":"/api-reference/phone-numbers/search-available-phone-numbers"},{"title":"List Available Cities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/available/cities","href":"/api-reference/phone-numbers/list-available-cities"},{"title":"Import Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/import","href":"/api-reference/phone-numbers/import-phone-number"},{"title":"List Carrier Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/carrier-accounts","href":"/api-reference/phone-numbers/list-carrier-accounts"},{"title":"Save Carrier Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /phone-numbers/carrier-accounts/{provider}","href":"/api-reference/phone-numbers/save-carrier-account"}]},{"group":"SMS","pages":[{"title":"Get SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sms/provider","href":"/api-reference/sms/get-sms-provider"},{"title":"Connect SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /sms/provider","href":"/api-reference/sms/connect-sms-provider"},{"title":"Disconnect SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sms/provider","href":"/api-reference/sms/disconnect-sms-provider"},{"title":"List SMS Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sms/templates","href":"/api-reference/sms/list-sms-templates"},{"title":"Add SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/templates","href":"/api-reference/sms/add-sms-template"},{"title":"Update SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /sms/templates/{id}","href":"/api-reference/sms/update-sms-template"},{"title":"Delete SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sms/templates/{id}","href":"/api-reference/sms/delete-sms-template"},{"title":"Send Test SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/test","href":"/api-reference/sms/send-test-sms"}]},{"group":"Voices","pages":[{"title":"List Voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voices","href":"/api-reference/voices/list-voices"}]},{"group":"Voice clones","pages":[{"title":"List Voice Clones","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-clones","href":"/api-reference/voice-clones/list-voice-clones"},{"title":"Create Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-clones","href":"/api-reference/voice-clones/create-voice-clone"},{"title":"Get Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-clones/{id}","href":"/api-reference/voice-clones/get-voice-clone"},{"title":"Update Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /voice-clones/{id}","href":"/api-reference/voice-clones/update-voice-clone"},{"title":"Delete Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice-clones/{id}","href":"/api-reference/voice-clones/delete-voice-clone"}]},{"group":"Models","pages":[{"title":"List Models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /models","href":"/api-reference/models/list-models"}]},{"group":"Bring your own keys","pages":[{"title":"Get BYOK Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok","href":"/api-reference/bring-your-own-keys/get-byok-status"},{"title":"Turn BYOK On or Off","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /byok","href":"/api-reference/bring-your-own-keys/turn-byok-on-or-off"},{"title":"List BYOK Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok/credentials","href":"/api-reference/bring-your-own-keys/list-byok-keys"},{"title":"Add BYOK Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /byok/credentials","href":"/api-reference/bring-your-own-keys/add-byok-key"},{"title":"Update BYOK Key Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /byok/credentials/{kind}","href":"/api-reference/bring-your-own-keys/update-byok-key-model"},{"title":"Delete BYOK Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /byok/credentials/{kind}","href":"/api-reference/bring-your-own-keys/delete-byok-key"},{"title":"List BYOK Voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok/voices","href":"/api-reference/bring-your-own-keys/list-byok-voices"},{"title":"Preview BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /byok/voices/preview","href":"/api-reference/bring-your-own-keys/preview-byok-voice"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"List Webhook Deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Test Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/test","href":"/api-reference/webhooks/test-webhook"},{"title":"Redeliver Webhook Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/redeliver","href":"/api-reference/webhooks/redeliver-webhook-events"}]},{"group":"Usage","pages":[{"title":"Get Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage","href":"/api-reference/usage/get-usage"},{"title":"Get Daily Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage/daily","href":"/api-reference/usage/get-daily-usage"},{"title":"List Call Log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage/calls","href":"/api-reference/usage/list-call-log"},{"title":"List Wallet Ledger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallet/ledger","href":"/api-reference/usage/list-wallet-ledger"},{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invoices","href":"/api-reference/usage/list-invoices"},{"title":"Get Customers Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/usage","href":"/api-reference/usage/get-customers-usage"},{"title":"Get Calls Summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/summary","href":"/api-reference/usage/get-calls-summary"},{"title":"Get WhatsApp Summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /whatsapp/summary","href":"/api-reference/usage/get-whatsapp-summary"}]},{"group":"Analytics","pages":[{"title":"Get Dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard","href":"/api-reference/analytics/get-dashboard"},{"title":"Get Agent Analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/analytics","href":"/api-reference/analytics/get-agent-analytics"}]},{"group":"Customers","pages":[{"title":"List Customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{id}","href":"/api-reference/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /customers/{id}","href":"/api-reference/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{id}","href":"/api-reference/customers/delete-customer"},{"title":"Restore Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/{id}/restore","href":"/api-reference/customers/restore-customer"},{"title":"List Customer Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{id}/keys","href":"/api-reference/customers/list-customer-keys"},{"title":"Create Customer Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/{id}/keys","href":"/api-reference/customers/create-customer-key"},{"title":"Revoke Customer Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{id}/keys/{keyId}","href":"/api-reference/customers/revoke-customer-key"}]},{"group":"Workspace","pages":[{"title":"Get Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workspace","href":"/api-reference/workspace/get-workspace"},{"title":"Update Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /workspace","href":"/api-reference/workspace/update-workspace"}]},{"group":"Projects","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects","href":"/api-reference/projects/list-projects"},{"title":"Create Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects","href":"/api-reference/projects/create-project"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Update Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /projects/{id}","href":"/api-reference/projects/update-project"},{"title":"Delete Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /projects/{id}","href":"/api-reference/projects/delete-project"}]},{"group":"Teams","pages":[{"title":"List Teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /teams","href":"/api-reference/teams/create-team"},{"title":"Get Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams/{id}","href":"/api-reference/teams/get-team"},{"title":"Update Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /teams/{id}","href":"/api-reference/teams/update-team"},{"title":"Delete Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}","href":"/api-reference/teams/delete-team"},{"title":"Add Team Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /teams/{id}/members/{memberId}","href":"/api-reference/teams/add-team-member"},{"title":"Remove Team Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}/members/{memberId}","href":"/api-reference/teams/remove-team-member"},{"title":"Grant Team Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /teams/{id}/projects/{projectId}","href":"/api-reference/teams/grant-team-project"},{"title":"Revoke Team Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}/projects/{projectId}","href":"/api-reference/teams/revoke-team-project"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members","href":"/api-reference/members/list-members"},{"title":"Get Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/{id}","href":"/api-reference/members/get-member"},{"title":"Update Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /members/{id}","href":"/api-reference/members/update-member"},{"title":"Remove Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /members/{id}","href":"/api-reference/members/remove-member"}]},{"group":"Invitations","pages":[{"title":"List Invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invitations","href":"/api-reference/invitations/list-invitations"},{"title":"Create Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /invitations","href":"/api-reference/invitations/create-invitation"},{"title":"Get Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invitations/{id}","href":"/api-reference/invitations/get-invitation"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /invitations/{id}","href":"/api-reference/invitations/revoke-invitation"}]},{"group":"Notifications","pages":[{"title":"Get Notification Preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification-preferences","href":"/api-reference/notifications/get-notification-preferences"},{"title":"Update Notification Preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /notification-preferences","href":"/api-reference/notifications/update-notification-preferences"}]},{"group":"Saved replies","pages":[{"title":"List Saved Replies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /saved-replies","href":"/api-reference/saved-replies/list-saved-replies"},{"title":"Create Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /saved-replies","href":"/api-reference/saved-replies/create-saved-reply"},{"title":"Get Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /saved-replies/{id}","href":"/api-reference/saved-replies/get-saved-reply"},{"title":"Update Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /saved-replies/{id}","href":"/api-reference/saved-replies/update-saved-reply"},{"title":"Delete Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /saved-replies/{id}","href":"/api-reference/saved-replies/delete-saved-reply"}]},{"group":"Contact groups","pages":[{"title":"List Contact Groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contact-groups","href":"/api-reference/contact-groups/list-contact-groups"},{"title":"Create Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contact-groups","href":"/api-reference/contact-groups/create-contact-group"},{"title":"Get Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contact-groups/{id}","href":"/api-reference/contact-groups/get-contact-group"},{"title":"Rename Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contact-groups/{id}","href":"/api-reference/contact-groups/rename-contact-group"},{"title":"Delete Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contact-groups/{id}","href":"/api-reference/contact-groups/delete-contact-group"},{"title":"Add Contacts To Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contact-groups/{id}/members","href":"/api-reference/contact-groups/add-contacts-to-group"},{"title":"Remove Contacts From Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contact-groups/{id}/members","href":"/api-reference/contact-groups/remove-contacts-from-group"}]},{"group":"Workflows","pages":[{"title":"Start a Workflow Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/{workflowId}/runs","href":"/api-reference/workflows/start-a-workflow-run"},{"title":"List Workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get a Workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows/{workflowId}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Send a Workflow Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/events","href":"/api-reference/workflows/send-a-workflow-event"}]}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/whats-new"}]}]},"basePath":"","title":"Configure Connection - ThinnestAI","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}