Update Agent

Update an agent's name, workflow definition, or configuration

1 min read

put/api/v1/workflow/{workflow_id}

Request example

curl --request PUT \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "workflow_definition": {},
  "template_context_variables": {},
  "workflow_configurations": {
    "agent_setup": {
      "agent_brief": "<string>",
      "tone": "<string>",
      "language": "<string>",
      "voice_provider": "<string>",
      "voice_name": "<string>",
      "behavior_notes": "<string>",
      "workflow_stages": [
        "<string>"
      ],
      "agent_name": "<string>",
      "use_case": "<string>",
      "call_type": "inbound"
    },
    "voice_clone_id": "<string>",
    "ambient_noise_configuration": {
      "enabled": false,
      "volume": 0.3
    },
    "max_call_duration": 300,
    "max_user_idle_timeout": 10,
    "smart_turn_stop_secs": 2,
    "turn_start_strategy": "default",
    "turn_start_min_words": 3,
    "provisional_vad_pause_secs": 1.5,
    "turn_stop_strategy": "transcription",
    "dictionary": "",
    "context_compaction_enabled": false,
    "call_dispositions": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "text_chat_inactivity_timeout_seconds": 1800,
    "external_pbx_field_mappings": [
      {
        "context_path": "<string>",
        "destination_field": "<string>"
      }
    ],
    "external_pbx_lead_headers": [
      "<string>"
    ]
  }
}'

Response

{
  "id": 1,
  "name": "<string>",
  "status": "<string>",
  "created_at": "2026-08-10T12:00:00Z",
  "workflow_definition": {},
  "current_definition_id": 1,
  "template_context_variables": {},
  "call_disposition_codes": {
    "disposition_codes": []
  },
  "total_runs": 1,
  "workflow_configurations": {},
  "version_number": 1,
  "version_status": "<string>",
  "workflow_uuid": "<string>"
}

put/api/v1/workflow/{workflow_id}

All fields are optional — only include the fields you want to change. Updating workflow_definition creates a new versioned definition while preserving the history of previous versions.

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

namestring · null#

Show child attributes

Any of

workflow_definitionobject · null#

Show child attributes

Any of

template_context_variablesobject · null#

Show child attributes

Any of

workflow_configurationsobject · null#

Show child attributes

Any of

agent_setupobject · null#

Show child attributes

voice_clone_idstring · null#

Show child attributes

ambient_noise_configurationobject#

Show child attributes

enabledboolean#

Default: false

volumenumber#

Default: 0.3

max_call_durationinteger#

Default: 300

Range: 0 < x <= 1200

max_user_idle_timeoutnumber#

Default: 10

smart_turn_stop_secsnumber#

Default: 2

turn_start_strategyenum<string>#

Default: "default"

Options:defaultmin_wordsprovisional_vad

turn_start_min_wordsinteger#

Default: 3

provisional_vad_pause_secsnumber#

Default: 1.5

turn_stop_strategyenum<string>#

Default: "transcription"

Options:transcriptionturn_analyzer

dictionarystring#

Default: ""

context_compaction_enabledboolean#

Default: false

call_dispositionsobject[]#

Allowed business outcomes for terminal call classification. Each entry defines the exact stored code and the criteria for selecting it.

Items: max 50

Show child attributes

codestringrequired#

Stable code recorded when this outcome is selected.

Length: 1–64Pattern: ^[A-Za-z][A-Za-z0-9_-]*$

descriptionstringrequired#

Business criteria for selecting this disposition.

Length: 1–1000

text_chat_inactivity_timeout_secondsinteger#

Default: 1800

Range: 60–10500

external_pbx_field_mappingsobject[]#

Items: max 100

Show child attributes

context_pathstringrequired#

Length: 1–255

destination_fieldstringrequired#

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,63}$

external_pbx_lead_headersstring[]#

Items: max 50

Responses

application/json

Successful Response

idintegerrequired#

namestringrequired#

statusstringrequired#

created_atstringrequired#

workflow_definitionobjectrequired#

current_definition_idinteger · nullrequired#

Show child attributes

Any of

template_context_variablesobject · null#

Show child attributes

Any of

call_disposition_codesobject · null#

Show child attributes

Any of

disposition_codesstring[]#

Default: []

total_runsinteger · null#

Show child attributes

Any of

workflow_configurationsobject · null#

Show child attributes

Any of

version_numberinteger · null#

Show child attributes

Any of

version_statusstring · null#

Show child attributes

Any of

workflow_uuidstring · null#

Show child attributes

Any of

Get Agent Archive Agent