Skip to main content
PATCH
Update inbound agent

Company + knowledge base

  • companyId — set to link; null clears; omit leaves unchanged
  • selectedKnowledgebases — replace with fileId list from list documents; [] clears; omit leaves unchanged
Picker sources: list companies, list knowledge documents. Healthcare HMS: Healthcare HMS integration.

Authorizations

Authorization
string
header
required

Paste only your API key (ond_live_… or ond_test_…). Do not type the word Bearer — the playground adds it.

Path Parameters

id
string
required

Body

application/json
name
string
greetingMessage
string
category
string
maxCallDuration
integer
fallbackNumber
string
concurrentCalls
integer
companyId
string | null

Set to link a company; null clears. Omit to leave unchanged (auto-pick only if agent still has no company).

selectedKnowledgebases
(string | object)[]

Replace linked KB docs by fileId list. Empty array clears. Omit to leave unchanged.

appointmentScope
enum<string>
Available options:
global,
hospital,
doctor
branchId
string
doctorId
string
customApiBaseUrl
string
customApiSecret
string
slotsEnabled
boolean
bookingEnabled
boolean
doctorsSyncEnabled
boolean
validateHookEnabled
boolean

Response

Updated

agent
object