Skip to content

bots.setLive

Turn an agent on or off for calls.

Reference

PUT/api/v1/workflows/{workflow_id}/live

Auth
API key in X-API-Key
Content
application/json
Returns
200 ยท WorkflowResponse

Turn an agent on or off for calls. Off means: inbound calls to any number pointed at this agent are rejected, the outbound test-call API refuses with 409, and a running campaign stops dialling for it. The agent itself is untouched โ€” still listed, still editable, still holding its numbers โ€” so turning it back on needs no reconfiguration. Deliberately not folded into ``PUT /{id}/status``. Archiving removes an agent from the working set; this pauses one that is still part of it, and a single field would have made "hide it" and "silence it" the same gesture.

Arguments

ArgumentInTypeRequiredDescription
workflow_idpathintegerrequired
is_livebodybooleanrequired

Example request

curl -X PUT "https://api.decibyl.ai/api/v1/workflows/<workflow_id>/live" \
  -H "X-API-Key: dcb_your_key" \
  -H "Content-Type: application/json" \
  -d '{"is_live":true}'

Response

{
  "id": 1,
  "name": "string",
  "status": "string",
  "is_live": true,
  "visibility": "everyone",
  "created_at": "2026-09-14T09:30: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"
}

Errors

StatusWhen
404Not found
422Validation Error