Skip to main content
PUT
Update Agent

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string
required

Body

application/json
type
enum<string>
required
Available options:
inbound,
outbound,
chat,
hybrid
Example:

"inbound"

workspaceId
string
Example:

"6970c2f3948cfbce1932d99d"

name
string
Example:

"Updated Agent"

category
string
Example:

"general"

description
string
Example:

"AI assistant for voice calls"

image
string
Example:

"1"

features
string[]
Example:
popularity
integer
Example:

0

voiceConfig
object
aiModel
object
llmConfig
object
sttConfig
object
voicemailConfig
object
backChannelConfig
object
timeoutConfig
object
callConfig
object
fillerWords
boolean
Example:

false

customVocabulary
string[]
Example:
timezone
string
Example:

"Asia/Kolkata"

greeting
string
Example:

"Hi! How can I assist you today?"

prompt
string
Example:

"You are a helpful AI assistant focused on providing accurate and friendly responses."

knowledgeBases
string[]
Example:
actions
string[]
Example:
deployment
object
stats
object
templateCategory
string | null
Example:

null

industry
string | null
Example:

null

Example:
localisedPrompt
string
Example:

"Localized prompt text"

multiLingual
boolean
Example:

false

primaryLanguage
string
Example:

"en"

secondaryLanguages
string[]
Example:
dynamic_variables
string[]
Example:
status
boolean
Example:

true

Response

Agent updated successfully

status
integer
Example:

200

message
string
Example:

"Assistant (simple) updated successfully"

data
object
Example: