Skip to main content
PATCH
/
agent
/
{agent_id}
Update Agent
curl --request PATCH \
  --url https://api.getoutbox.ai/agent/{agent_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "timezone": "<string>",
  "first_message": "<string>",
  "webhook_url": "<string>",
  "branding_colour": "<string>",
  "interrupt_mode": "true",
  "prompt": "<string>",
  "line_edits": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API Key

Path Parameters

​
agent_id
string
required

The ID of the agent to update

Body

application/json

Agent fields to update

​
name
string

Agent name

​
timezone
string

Timezone name (e.g. "America/New_York")

​
first_message
string

First message shown in supported chat surfaces

​
webhook_url
string

Webhook URL (if applicable)

​
branding_colour
string

"" or hex #RGB / #RRGGBB

​
interrupt_mode
enum<string>

Chat agent interrupt mode toggle

Available options:
true,
false
​
prompt
string

Full prompt replacement

​
line_edits
object[]

Incremental prompt edits applied server-side

Response

Agent updated successfully