Skip to main content
PATCH
/
public
/
agent
/
{agent_id}
Update Agent
curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/public/agent/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "agent_name": "My Updated Agent",
  "introduction_and_objective": "You are a customer support agent for Acme Corp.",
  "response_guidelines": "Be polite, helpful, and concise. Always confirm understanding.",
  "task": "Help customers with their orders and answer product questions.",
  "faq": "Q: What are your hours? A: We are open 9am-6pm IST.",
  "sample_conversations": "User: Hi\nAgent: Hello! How can I help you today?",
  "primary_language": "en-IN",
  "secondary_language": "hi-IN",
  "voice_id": "02ad256b-092b-4048-bea0-5af46a452b98",
  "intro_message": "Hello, this is Sarah from Acme Corp. How can I assist you today?",
  "agent_type": "outbound",
  "custom_variables": [
    "callee_name",
    "mobile_number",
    "company",
    "lead_source"
  ]
}
'
{
  "success": true,
  "data": {
    "id": "edd618d3-f473-4ac1-b5fa-f1a3981666ff",
    "version": "v1",
    "updated_at": "2024-12-16T14:15:32.123456+00:00"
  },
  "message": "Agent updated successfully"
}

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

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

Path Parameters

​
agent_id
string<uuid>
required

(Required) The unique ID of the agent to update

Example:

"edd618d3-f473-4ac1-b5fa-f1a3981666ff"

Body

application/json
​
agent_name
string

(Optional) Name of the agent

Maximum string length: 100
Example:

"My Updated Agent"

​
introduction_and_objective
string

(Optional) Introduction and objective of the agent

Maximum string length: 2000
Example:

"You are a customer support agent for Acme Corp."

​
response_guidelines
string

(Optional) Guidelines for how the agent should respond

Maximum string length: 3000
Example:

"Be polite, helpful, and concise. Always confirm understanding."

​
task
string

(Optional) The task the agent should perform

Maximum string length: 1500
Example:

"Help customers with their orders and answer product questions."

​
faq
string

(Optional) FAQ content for the agent

Maximum string length: 5000
Example:

"Q: What are your hours? A: We are open 9am-6pm IST."

​
sample_conversations
string

(Optional) Example conversations for the agent. Use \n for newlines between turns.

Maximum string length: 5000
Example:

"User: Hi\nAgent: Hello! How can I help you today?"

​
primary_language
enum<string>

(Optional) Primary language locale for the agent

Available options:
en-US,
en-IN,
hi-IN,
ta-IN,
te-IN,
bn-IN,
mr-IN,
kn-IN,
ka-IN
Example:

"en-IN"

​
secondary_language
enum<string>

(Optional) Secondary language locale for the agent

Available options:
en-US,
en-IN,
hi-IN,
ta-IN,
te-IN,
bn-IN,
mr-IN,
kn-IN,
ka-IN
Example:

"hi-IN"

​
voice_id
string<uuid>

(Optional) Internal AgentVoice ID (UUID). Get available voices from the Get Assistant Voices endpoint.

Example:

"02ad256b-092b-4048-bea0-5af46a452b98"

​
intro_message
string

(Optional) Introduction message the agent will speak when the call starts

Maximum string length: 500
Example:

"Hello, this is Sarah from Acme Corp. How can I assist you today?"

​
agent_type
enum<string>

(Optional) Type of agent

Available options:
inbound,
outbound,
outbound_inbound
Example:

"outbound"

​
custom_variables
string[]

(Optional) Custom variables for the agent. For outbound agents, callee_name and mobile_number cannot be removed.

Example:
[
  "callee_name",
  "mobile_number",
  "company",
  "lead_source"
]

Response

Agent updated successfully.

​
success
boolean
Example:

true

​
data
object
​
message
string
Example:

"Agent updated successfully"