Skip to main content
PATCH
/
api
/
agents
/
{agent_uid}
Update agent
curl --request PATCH \
  --url https://api.example.com/api/agents/{agent_uid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "status": "<string>",
  "notification_config": {}
}
'
Partially updates an agent’s configuration. Only include fields you want to change.

​
Path parameters

​
agent_uid
string
required
UUID of the agent.

​
Request body

All fields are optional. Only provided fields are updated.
​
name
string
Display name. 1–128 characters.
​
description
string
Short description.
​
instructions
string
Natural-language instructions defining the agent’s behavior.
​
status
string
Agent status. One of: draft, active, paused.
​
notification_config
object
Slack notification settings. Send null to clear all notification configuration.
​
slack_channel_id
string
required
Slack channel ID to post notifications to. The Exante bot must be a member of the channel.
​
events
object
Toggle individual notification events:
  • action_taken (default true)
  • approval_required (default true)
  • outcome (default true)
  • error (default true)
  • digest (default false)

​
Activating an agent

{
  "status": "active"
}

​
Updating instructions

{
  "instructions": "You are a collections agent. When an invoice is 15+ days overdue, draft a follow-up email to the primary billing contact."
}

​
Configuring notifications

{
  "notification_config": {
    "slack_channel_id": "C0123456789",
    "events": {
      "action_taken": true,
      "approval_required": true,
      "outcome": true,
      "error": true,
      "digest": false
    }
  }
}

​
Response

Returns 200 with the updated agent: 
{
  "status": "success",
  "status_code": 200,
  "message": "Agent updated",
  "data": {
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_uid": "550e8400-e29b-41d4-a716-446655440000",
    "agent_type": "collections",
    "name": "Collections Agent",
    "description": "Follows up on overdue invoices via email",
    "instructions": "You are a collections agent...",
    "status": "active",
    "created_by_uid": "660e8400-e29b-41d4-a716-446655440000",
    "notification_config": null,
    "runs_count": 12,
    "created_on": "2026-03-10T14:30:00Z",
    "updated_on": "2026-03-20T10:00:00Z",
    "triggers": [],
    "tools": []
  }
}
When setting notification_config.slack_channel_id, the Exante bot must already be a member of the channel. If not, invite it with /invite @Exante in Slack first.