Patch update agent
curl --request PATCH \
--url https://prod-platform-core-api.20x.business/api/v1/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"greetMessage": "<string>",
"agent_prompt": "<string>",
"metadata": {},
"channel": "<string>",
"settings": {},
"connectionId": "<string>"
}
'import requests
url = "https://prod-platform-core-api.20x.business/api/v1/agents/{id}"
payload = {
"name": "<string>",
"greetMessage": "<string>",
"agent_prompt": "<string>",
"metadata": {},
"channel": "<string>",
"settings": {},
"connectionId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
greetMessage: '<string>',
agent_prompt: '<string>',
metadata: {},
channel: '<string>',
settings: {},
connectionId: '<string>'
})
};
fetch('https://prod-platform-core-api.20x.business/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Agents
Patch update agent
Partially update an agent’s configuration
PATCH
/
agents
/
{id}
Patch update agent
curl --request PATCH \
--url https://prod-platform-core-api.20x.business/api/v1/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"greetMessage": "<string>",
"agent_prompt": "<string>",
"metadata": {},
"channel": "<string>",
"settings": {},
"connectionId": "<string>"
}
'import requests
url = "https://prod-platform-core-api.20x.business/api/v1/agents/{id}"
payload = {
"name": "<string>",
"greetMessage": "<string>",
"agent_prompt": "<string>",
"metadata": {},
"channel": "<string>",
"settings": {},
"connectionId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
greetMessage: '<string>',
agent_prompt: '<string>',
metadata: {},
channel: '<string>',
settings: {},
connectionId: '<string>'
})
};
fetch('https://prod-platform-core-api.20x.business/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));This is the primary way to configure an agent after creation — rename it,
set its prompt/greeting, assign a telephony number, or connect WhatsApp.
Only the fields you include are changed; everything else is left as-is.
Path parameters
string
required
The agent ID
Common body fields
string
New display name
string
First line the agent speaks/sends
string
System prompt
object
Free-form metadata, e.g.
{ fallback_message }string
"VOICE" when setting telephony fields belowobject
Channel-specific settings — see examples
string
An integration ID (e.g. the WhatsApp integration)
curl -X PATCH https://prod-comms-engine-api.20x.business/api/v1/agents/AGENT_ID \
-H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Support Agent v2" }'
curl -X PATCH https://prod-comms-engine-api.20x.business/api/v1/agents/AGENT_ID \
-H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"greetMessage": "Hello! How can I help you today?",
"agent_prompt": "You are a helpful customer support assistant.",
"metadata": { "fallback_message": "Sorry, could you repeat that?" }
}'
curl -X PATCH https://prod-comms-engine-api.20x.business/api/v1/agents/AGENT_ID \
-H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "VOICE",
"settings": { "phone_provider": "PLIVO", "phone_number": "912269976288" }
}'
curl -X PATCH https://prod-comms-engine-api.20x.business/api/v1/agents/AGENT_ID \
-H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connectionId": "WHATSAPP_INTEGRATION_ID",
"settings": { "phoneNumberId": "WHATSAPP_PHONE_NUMBER_ID" }
}'
To enable WhatsApp on an agent, first call
POST /agents/{id}/webhook-token
to generate its per-agent webhook token, then patch the connection as above.