Skip to main content
PATCH
/
agent
/
v1
Edit Assistant
curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/agent/v1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "operation": "edit_agent_display_name",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "agent_display_name": "Updated Sales Assistant",
  "language": "en-US",
  "voice_id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
  "secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
  "secondary_language": "hi-IN",
  "agent_prompt": "You are a helpful sales assistant.",
  "custom_variables": [
    "callee_name",
    "mobile_number",
    "company",
    "lead_source"
  ],
  "number_id": "5d7f9a2b-1c3e-4f6a-8b9c-0d1e2f3a4b5c",
  "kb_id": "7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d",
  "whitelisted_domains": [
    "https://www.ringg.ai",
    "https://example.com"
  ],
  "voice_speed": 1.2
}
'
{
  "message": "Agent updated successfully!",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9"
}
Update an existing assistant. The request uses an operation field so each edit is explicit, such as updating prompts, variables, or webhook event subscriptions.

​
When to use

  • Update assistant configuration from your own admin backend.
  • Configure event subscriptions for webhooks.
  • Keep assistant behavior synchronized with templates in your product.

​
Integration notes

  • Test configuration changes with one individual call before running a campaign.
  • Avoid overwriting unrelated assistant settings in broad update flows.
  • For webhook setup, use operation: "edit_event_subscriptions" and provide the events plus callback URL Ringg should call.
See webhook setup for a complete event subscription example.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Body

application/json
​
operation
enum<string>
required
Available options:
attach_inbound_number,
remove_inbound_number,
attach_kb,
remove_kb,
edit_custom_vars,
edit_language,
edit_voice,
edit_prompt,
edit_noise_settings,
edit_agent_display_name,
edit_intro_message,
edit_query_phrases,
edit_dtmf_settings,
edit_vad_settings,
edit_agent_whitelisted_domains,
edit_voice_speed,
edit_extract_callee_name,
edit_vocab,
edit_api_settings,
edit_secondary_language,
edit_secondary_voice
Example:

"edit_agent_display_name"

​
agent_id
string
required
Example:

"830f767a-397e-4b39-82ff-235cd344e2f9"

​
agent_display_name
string
Example:

"Updated Sales Assistant"

​
language
enum<string>
Available options:
en-US,
en-IN,
hi-IN,
ta-IN,
te-IN,
kn-IN,
mr-IN,
gu-IN,
ar-AE
Example:

"en-US"

​
voice_id
string
Example:

"3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d"

​
secondary_voice_id
string
Example:

"4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e"

​
secondary_language
enum<string>
Available options:
en-US,
en-IN,
hi-IN,
ta-IN,
te-IN,
kn-IN,
mr-IN,
gu-IN,
ar-AE
Example:

"hi-IN"

​
agent_prompt
Example:

"You are a helpful sales assistant."

​
custom_variables
string[]
Example:
[
  "callee_name",
  "mobile_number",
  "company",
  "lead_source"
]
​
number_id
string
Example:

"5d7f9a2b-1c3e-4f6a-8b9c-0d1e2f3a4b5c"

​
kb_id
string
Example:

"7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d"

​
whitelisted_domains
string[]
Example:
[
  "https://www.ringg.ai",
  "https://example.com"
]
​
voice_speed
number
Example:

1.2

Response

Successful Response: Assistant updated successfully.

​
message
string
Example:

"Agent updated successfully!"

​
agent_id
string
Example:

"830f767a-397e-4b39-82ff-235cd344e2f9"