Skip to main content
PATCH
/
v1
/
agents
/
{id}
curl -X PATCH https://api.saturn-pay.com/v1/agents/agt_abc123 \
  -H "Authorization: Bearer sk_agt_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "renamed-agent"
  }'
{
  "id": "agt_abc123",
  "name": "renamed-agent",
  "killed": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "lastActiveAt": "2024-01-20T14:22:00Z"
}
Updates an agent’s name or kill switch status.

Path Parameters

id
string
required
The agent ID (e.g., agt_abc123)

Request

name
string
New name for the agent
killed
boolean
Set to true to enable kill switch (immediately blocks all API calls). Set to false to disable.

Response

Returns the updated agent object.
curl -X PATCH https://api.saturn-pay.com/v1/agents/agt_abc123 \
  -H "Authorization: Bearer sk_agt_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "renamed-agent"
  }'
{
  "id": "agt_abc123",
  "name": "renamed-agent",
  "killed": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "lastActiveAt": "2024-01-20T14:22:00Z"
}