Connect Account
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 and zoho_bigin 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.
Authorizations
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
Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.
"org_3fKq9TzQ1mN8vB2xR7cLpA"
Path Parameters
The agent's id (ag_…).
The connection: calcom (calendar), grist or googlesheets (spreadsheets), zoho or zoho_bigin (CRMs), records (kept here), zendesk or salesforce (helpdesks).
calcom, grist, googlesheets, zoho, zoho_bigin, records, zendesk, salesforce Body
- calcom
- grist
- records
- zendesk
- salesforce
The body depends on {kind}. googlesheets, zoho and zoho_bigin take no body here: they sign in through a browser in the console, and this answers 409.
A live Cal.com API key (cal_live_…), from Settings → Developer → API keys. Write-only.
Response
Connected. inbound (helpdesks) and link.passcode (a new records link) appear only here.
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.
The connection.
calcom, grist, googlesheets, zoho, zoho_bigin, records, zendesk, salesforce Its display name.
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.
key, browser, none Whether this deployment offers it at all.
Whether it is connected.
Who it is connected as: { email, name }, or { host, email } for a helpdesk.
Show child attributes
Show child attributes
Why the last attempt to use it failed.
Connection tools switched on, across every connection.
The shared budget.
What happened.
Browser sign-ins only: a sign-in was started in the console and not finished.
Calendar only: the account's timezone.
All but the calendar and helpdesks: tool saves during the conversation; parser reads the conversation afterwards.
tool, parser Grist only: answer before the save finishes.
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 }.
Spreadsheets and CRMs: the column that finds a lead's existing row, or null to add a row per conversation.
Show child attributes
Show child attributes
Spreadsheets and CRMs: column to campaign variable.
Show child attributes
Show child attributes
Its tools. Helpdesks have none here.
Show child attributes
Show child attributes
Records only: what is collected.
Show child attributes
Show child attributes
Records only: how many records have been collected.
Records only: the link to read them. The passcode is shown only by the call that makes a link.
Show child attributes
Show child attributes
Helpdesks only: whether it is in use.
Helpdesks only, and only in this response: paste both into the helpdesk's webhook so replies reach the agent.
Show child attributes
Show child attributes