PUT
/
api
/
v1
/
workflow
/
{workflow_id}
/
status
Update Workflow Status
curl --request PUT \
  --url https://app.dograh.com/api/v1/workflow/{workflow_id}/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "workflow_definition": {},
  "current_definition_id": 123,
  "template_context_variables": {},
  "call_disposition_codes": {
    "disposition_codes": []
  },
  "total_runs": 123,
  "workflow_configurations": {},
  "version_number": 123,
  "version_status": "<string>",
  "workflow_uuid": "<string>"
}
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.

Headers

​
authorization
string | null
​
X-API-Key
string | null

Path Parameters

​
workflow_id
integer
required

Body

application/json
​
status
string
required

Response

Successful Response

​
id
integer
required
​
name
string
required
​
status
string
required
​
created_at
string<date-time>
required
​
workflow_definition
Workflow Definition · object
required
​
current_definition_id
integer | null
required
​
template_context_variables
Template Context Variables · object
​
call_disposition_codes
CallDispositionCodes · object
​
total_runs
integer | null
​
workflow_configurations
Workflow Configurations · object
​
version_number
integer | null
​
version_status
string | null
​
workflow_uuid
string | null