curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://response.stateset.com/api/v1/agents/{id}' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"activated": true
}'
{
"object": "agent",
"id": "3f9c2a10-7b4e-4d8a-9c1e-5a2b8d7f6e01",
"name": "Quickstart Support",
"type": "customer_service",
"description": "Answers order and return questions",
"activated": true,
"goal": "",
"role": "Customer Support Specialist",
"updated_at": "2026-09-20T12:00:00Z",
"instructions": "Help customers with orders and returns. Ask for missing information and escalate when you cannot verify an answer."
}
Update an agent; set activated:true to launch it
The updated agent
PATCH
/
api
/
v1
/
agents
/
{id}
curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://response.stateset.com/api/v1/agents/{id}' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"activated": true
}'
{
"object": "agent",
"id": "3f9c2a10-7b4e-4d8a-9c1e-5a2b8d7f6e01",
"name": "Quickstart Support",
"type": "customer_service",
"description": "Answers order and return questions",
"activated": true,
"goal": "",
"role": "Customer Support Specialist",
"updated_at": "2026-09-20T12:00:00Z",
"instructions": "Help customers with orders and returns. Ask for missing information and escalate when you cannot verify an answer."
}
Path parameters
string (uuid)
required
The agent id.
Request body
UpdateAgent
string
Minimum length:
1. Maximum length: 200.string
One of: assistant, customer_service, sales. Minimum length:
1. Maximum length: 100.string
Maximum length:
5000.string
The system prompt / persona. Maximum length:
50000.string
Maximum length:
2000.string
Maximum length:
2000.boolean
Response
Agent
string
Fixed value:
'agent'.string
string,null
string,null
string,null
boolean
string,null
string,null
string,null
string,null
Present on single-agent reads and writes only.
AgentSettingsOut
Status codes
| Code | Meaning |
|---|---|
200 | The updated agent |
400 | Invalid request. issues names the offending field(s). |
401 | Missing, invalid, or expired API key. |
403 | The key lacks a required scope. |
404 | Not found, or not in the organization that owns the key. |
429 | Rate limit exceeded. |
Access
| Required scope | agents:write |
| Rate limit | 30 requests per minute |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://response.stateset.com/api/v1/agents/{id}' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"activated": true
}'
{
"object": "agent",
"id": "3f9c2a10-7b4e-4d8a-9c1e-5a2b8d7f6e01",
"name": "Quickstart Support",
"type": "customer_service",
"description": "Answers order and return questions",
"activated": true,
"goal": "",
"role": "Customer Support Specialist",
"updated_at": "2026-09-20T12:00:00Z",
"instructions": "Help customers with orders and returns. Ask for missing information and escalate when you cannot verify an answer."
}
Last modified on September 21, 2026