## Query format {#query}
Before making a request, [get permission to access the API](https://yandex.ru/support/tracker/en/api-ref/access.md).
To create an auto action, use an HTTP `POST` request. In the request body, specify the parameters in JSON format.
```json
POST /v3/queues//autoactions
Host: api.tracker.yandex.net
Authorization: OAuth
X-Org-ID or X-Cloud-Org-ID:
{
"name": "",
"filter": [],
"actions": []
}
```
{% cut "Headers" %}
* `Host`: address of the node that provides the API.
*
`Authorization`: Authorization token about these formats:
- `OAuth `: For authorization using the OAuth 2.0 protocol. [Learn more](https://yandex.ru/support/tracker/en/api-ref/access.md#about_OAuth)
- `Bearer `: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. [Learn more](https://yandex.ru/support/tracker/en/api-ref/access.md#iam-token)
*
`X-Org-ID` or `X-Cloud-Org-ID`: Organization ID.
- Use the `X-Org-ID` header if a Tracker organization is linked to Yandex 360 for Business.
- Use the `X-Cloud-Org-ID` header if a Tracker organization is linked to Yandex Identity Hub.
To get the organization ID, go to **Administration** → [**Organizations**](https://tracker.yandex.com/admin/orgs) and copy the value from the **ID** field. {#find-id}
{% endcut %}
{% cut "Resource" %}
| Parameter | Description | Data type |
----- | ----- | -----
| \ | Queue ID or key. The queue key is case-sensitive. | String or number |
{% endcut %}
{% cut "Request body parameters" %}
**Required parameters**
{% note info "" %}
In the request body, specify at least one of the parameters: `filter` or `query`.
{% endnote %}
| Parameter | Description | Data type |
----- | ----- | -----
| name | Auto action name | String |
| [filter](#filter) | Array with the issue field filtering conditions that will trigger the auto action | Array of objects |
| query | The query string to filter the issues that will trigger the auto action. The [query language](../../user/query-filter.md) is used. For example: `"query": "\"Status\":\"In progress\""` | String |
| [actions](#actions) | Array of actions on issues | Array of objects |
**Additional parameters**
| Parameter | Description | Data type |
----- | ----- | -----
| active | Auto action status. Acceptable values include:
| Boolean |
| intervalMillis | Auto action start frequency in milliseconds. The default value is `3600000` (once an hour). | Number |
| calendar | Period for which the auto action is active. It has the `id` parameter specifying the [work schedule](../../manager/schedule.md) ID. | Map item |
{% endcut %}
> Example: Creating an auto action that triggers on issues that meet the filter criteria and changes the status of the issues.
> - An HTTP POST method is used.
> - Create an auto action for the DESIGN queue.
> - Filter criteria: issues in the `In progress` status with **Priority** set to `Critical`.
> - Action performed: the issue status changes to **Need info**.
> - Trigger period: work schedule with the ID of `2`.
> ```json
> POST /v3/queues/DESIGN/autoactions
> Host: api.tracker.yandex.net
> Authorization: OAuth
> X-Org-ID or X-Cloud-Org-ID:
> {
> "name": "AutoactionName",
> "filter": {
> "priority": [
> "critical"
> ],
> "status": [
> "inProgress"
> ]
> },
> "actions": [
> {
> "type": "Transition",
> "status": {
> "key": "needInfo"
> }
> }
> ],
> "calendar": {
> "id": 2
> }
> }
> ```
## Response format {#answer}
{% list tabs %}
- Request executed successfully
If the request is successful, the API returns a response with code `200 OK`.
The request body contains information about the created auto action in JSON format.
```json
{
"id": 9,
"self": "https://api.tracker.yandex.net/v3/queues/DESIGN/autoactions/9",
"queue": {
"self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
"id": "26",
"key": "DESIGN",
"display": "Design"
},
"name": "autoaction_name",
"version": 1,
"active": true,
"created": "2022-01-21T17:10:22.993+0000",
"updated": "2022-01-21T17:10:22.993+0000",
"filter": {
"assignee": [
"13********"
],
"priority": [
"critical"
]
},
"actions": [
{
"type": "Transition",
"id": 1,
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/2",
"id": "2",
"key": "needInfo",
"display": "Need info"
}
}
],
"enableNotifications": false,
"totalIssuesProcessed": 0,
"intervalMillis": 3600000,
"calendar": {
"id": 2
}
}
```
{% cut "Response parameters" %}
| Parameter | Description | Data type |
----- | ----- | -----
| id | Auto action ID | String |
| self | Link to the auto action | String |
| [queue](#queue) | Queue to create the auto action. | Can be set as an object, a string (if the [queue key](../../manager/create-queue.md#key) is provided), or a number (if the queue ID is provided). |
| name | Auto action name | String |
| version | Auto action version. Each change to the auto action increases the version number. | Number |
| active | Auto action status. Acceptable values include:
`true`: Active
`false`: Inactive
| Boolean |
| created | Auto action creation date and time in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format | String |
| updated | Date and time of the auto action's last update in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format | String |
| [filter](#filter) | Array with the issue field filtering conditions that will trigger the auto action | Array of objects |
| query | Query string for filtering issues | String |
| [actions](#actions) | Array of actions on issues | Array of objects |
| enableNotifications | Notification sending statuses. Acceptable values include:
`true`: Send.
`false`: Do not send.
| Boolean |
| totalIssuesProcessed | Number of issues checked by the auto action when triggered last time | Number |
| intervalMillis | Auto action start frequency in milliseconds. The default value is `3600000` (once an hour). | Number |
| calendar | Period for which the auto action is active. It has the `id` parameter specifying the [work schedule](../../manager/schedule.md) ID. | Map item |
`queue` **object fields** {#queue}
| Parameter | Description | Data type |
----- | ----- | -----
| self | Address of the API resource with information about the queue. | String |
| id | Queue ID. | String |
| key | Queue key. | String |
| display | Queue name displayed. | String |
`filter` **array object fields** {#filter}
| Parameter | Description | Data type |
----- | ----- | -----
| filter | Array with filtering conditions for issue fields. Use the request to get the ID of the [global](../issues/get-global-fields.md) or [local](../queues/get-local-fields.md) field. | Array of objects |
`actions` **array object fields** {#actions}
| Parameter | Description | Data type |
----- | ----- | -----
| type | Action type. Acceptable values include:
`Transition`: Change the issue status.
`Update`: Change a field value.
`Event.comment-create`: Add a comment.
`Webhook`: Send an HTTP request.
`CalculateFormula`: Calculate a value.
| String |
| id | Action ID | String |
| [status](#status) | Issue status | String |
`status` **array object fields** {#status}
| Parameter | Description | Data type |
----- | ----- | -----
| self | Address of the API resource with information about the status. | String |
| id | Status ID. | String |
| key | Status key. | String |
| display | Status name displayed. | String |
{% endcut %}
- Request failed
If the request is processed incorrectly, the API returns a message with error details:
400
: One or more request parameters have an invalid value.
403
: You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
: The requested object was not found. You may have specified an invalid object ID or key.
422
: JSON validation error, the request is rejected.
500
: Internal service error. Try again later.
503
: The API service is temporarily unavailable.
{% endlist %}