Change scenario priority

Description

The request enables or disables high priority for a scenario. Tasks of high-priority scenarios are processed by dedicated workers. See High-priority scenarios.

The change affects new scenario tasks. Tasks that are already in the queue are processed with the old priority.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
id	int	1	Yes	Scenario identifier
high_priority	bool	true	Yes	Scenario high priority: true or false

Request example

JSON

{  
    "id": 1, 
    "high_priority": true 
}

XML

<xml>
    <id>1</id>
    <high_priority>true</high_priority>
</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