Enable an Automation

Activate scenario

Activates the specified scenario. Also runs the scenario if the scenario is scheduled to run at regular intervals. Read more about scenario scheduling.

The API call response contains the scenario ID and the scenario isActive property set to true.

POST/api/v2/scenarios/{scenarioId}/start

Authorization

token

Path parameters

scenarioId*integer

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Example: 112

Response

200

Successful response

Body

application/json

scenarioobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v2/scenarios/{scenarioId}/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "scenario": {
    "id": 0,
    "isActive": false
  }
}