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>",
  "interrupt_mode": "true",
  "log_to_crm": "true",
  "prompt": "<string>",
  "model": {
    "model": "<string>",
    "max_tokens": 123,
    "temperature": 123
  },
  "voice": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "provider": "11labs",
    "accent": "<string>",
    "gender": "<string>",
    "previewUrl": "<string>",
    "style": 123,
    "speed": 123,
    "stability": 123,
    "similarityBoost": 123,
    "useSpeakerBoost": true,
    "optimizeStreamingLatency": 123,
    "autoMode": true,
    "model": "<string>"
  },
  "language": "<string>",
  "keyterms": "<string>",
  "background": "lounge",
  "background_url": "<string>",
  "hipaa_enabled": "true",
  "forwarding_number": "<string>",
  "voicemail_message": "<string>",
  "end_call_message": "<string>",
  "recording_consent_message": "<string>",
  "unqualified_prompt": "<string>",
  "scoring_prompt": "<string>",
  "summary_prompt": "<string>"
}
'

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>",
  "interrupt_mode": "true",
  "log_to_crm": "true",
  "prompt": "<string>",
  "model": {
    "model": "<string>",
    "max_tokens": 123,
    "temperature": 123
  },
  "voice": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "provider": "11labs",
    "accent": "<string>",
    "gender": "<string>",
    "previewUrl": "<string>",
    "style": 123,
    "speed": 123,
    "stability": 123,
    "similarityBoost": 123,
    "useSpeakerBoost": true,
    "optimizeStreamingLatency": 123,
    "autoMode": true,
    "model": "<string>"
  },
  "language": "<string>",
  "keyterms": "<string>",
  "background": "lounge",
  "background_url": "<string>",
  "hipaa_enabled": "true",
  "forwarding_number": "<string>",
  "voicemail_message": "<string>",
  "end_call_message": "<string>",
  "recording_consent_message": "<string>",
  "unqualified_prompt": "<string>",
  "scoring_prompt": "<string>",
  "summary_prompt": "<string>"
}
'

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 for the agent

first_message

string

Initial message

webhook_url

string

Webhook URL for callbacks

interrupt_mode

enum<string>

Enable interrupt mode (chatbot only)

Available options:

true,

false

log_to_crm

enum<string>

Log conversations to CRM

Available options:

true,

false

prompt

string

System prompt

model

object

AI model configuration

Show child attributes

model.model

string

AI model name (e.g., 'gpt-4.1-mini', 'gpt-4.1', 'gpt-4o', 'gpt-5')

model.max_tokens

integer

Maximum number of tokens in the model's response

model.temperature

number

Controls randomness and creativity of responses (0.0 to 1.0). Lower values make responses more focused and deterministic, while higher values allow for more varied responses.

voice

object

Voice settings (voicebot only)

Show child attributes

voice.id

string

Unique identifier for the voice

voice.name

string

Name of the voice

voice.description

string

Description of the voice characteristics

voice.provider

enum<string>

Voice provider

Available options:

11labs,

playht,

openai

voice.accent

string

Voice accent (e.g., 'australian', 'american', 'british')

voice.gender

string

Voice gender (e.g., 'male', 'female')

voice.previewUrl

string<uri>

URL to preview the voice

voice.style

number

Style exaggeration (default: 0.00). High values exaggerate the style compared to uploaded audio but can lead to instability. Setting to 0.0 greatly increases generation speed.

voice.speed

number

Speed of speech generation (default: 1.00)

voice.stability

number

Stability control (default: 0.45). Increasing variability makes speech more expressive with output varying between re-generations, but can lead to instabilities.

voice.similarityBoost

number

Clarity + Similarity (default: 0.65). Low values are recommended if background artifacts are present in generated speech.

voice.useSpeakerBoost

boolean

Boost the similarity of synthesized speech and the voice at the cost of some generation speed

voice.optimizeStreamingLatency

integer

Controls streaming latency optimization level (0-4, default: 1)

voice.autoMode

boolean

Reduces latency for complete sentences but may affect quality with partial phrases

voice.model

string

ElevenLabs voice model (e.g., 'eleven_turbo_v2', 'eleven_turbo_v2_5', 'eleven_multilingual_v1', 'eleven_multilingual_v2', 'eleven_english_v1')

language

string

Language (voicebot only)

keyterms

string

Space-separated keywords (voicebot only)

background

enum<string>

Background audio (voicebot only)

Available options:

lounge,

off,

url

background_url

string<uri>

Custom background audio URL used when background is set to url (voicebot only)

hipaa_enabled

enum<string>

HIPAA compliance (voicebot only)

Available options:

true,

false

forwarding_number

string

Call forwarding number (voicebot only)

voicemail_message

string

Voicemail message (voicebot only)

end_call_message

string

End call message (voicebot only)

Recording consent message (voicebot only)

unqualified_prompt

string

Unqualified lead prompt (voicebot only)

scoring_prompt

string

Lead scoring prompt (voicebot only)

summary_prompt

string

Call summary prompt (voicebot only)

Response

Agent updated successfully

Create Agent Duplicate Agent

⌘I

API Documentation

Agent Endpoints

Chat & Call Endpoints

Agent Files

Agent Integrations

Agent Tools

Module Instance Endpoints

Module Configuration

Module Scheduling

Contact Endpoints

Conversation Endpoints

Call Logs

Chat Logs

Transcripts

Company Settings

Company Staff Management

Company Phone Numbers

Agency Settings

Agency Companies

Agency Phone Numbers

Update Agent

Authorizations

Path Parameters

Body

Response