Activate scenario

Description

The request is used to activate a scenario.

URL

Method: POST

https://example.com/api/v1.1/workflows/activate

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	1	Yes	Scenario ID
skip_profiles	bool	true	No	Clear the scenario before reactivating

Request example

JSON

{  
    "token": "abcdefghijklmnqrstuvwxyz",  
    "id": 1, 
    "skip_profiles": true 
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>1</id>
    <skip_profiles>true</skip_profiles>
</xml>

Response example

JSON

{
    "data": null,
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data/>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text