Open Menace Voice

Archive Agent

Archive or restore a voice agent

1 min read

put/api/v1/workflow/{workflow_id}/status

Request example

curl --request PUT \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/status \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "<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}/status

Send {"status": "archived"} to deactivate an agent, or {"status": "active"} to restore it. Archived agents cannot receive calls but their history and definition are preserved.

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

statusstringrequired#

Responses

application/json

Successful Response

idintegerrequired#

namestringrequired#

statusstringrequired#

created_atstringrequired#

workflow_definitionobjectrequired#

current_definition_idinteger · nullrequired#

Show child attributes

template_context_variablesobject · null#

Show child attributes

call_disposition_codesobject · null#

Show child attributes

total_runsinteger · null#

Show child attributes

workflow_configurationsobject · null#

Show child attributes

version_numberinteger · null#

Show child attributes

version_statusstring · null#

Show child attributes

workflow_uuidstring · null#

Show child attributes

Update Agent Validate Workflow