Get trigger campaigns list
Description
Retrieves trigger campaigns list.
Request URL
Method: POST
https://example.com/api/v1.1/campaigns/triggers/list/
Request parameters
Parameter | Type | Example | Required | description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
from_id | int | 11768 | No | The first campaign in response ID. By default – 1 |
limit | int | 10 | No | Trigger campaigns list limit. By default – 1000 |
format | string | "json" | No | Response data format. By default – json |
is_active | bool | true | No | Retrieve only active campaigns |
ui_tags | []String | [ "tag1", "tag2" ] | No | List of tags for search |
groups | []String | [ "group1", "group2" ] | No | List of access groups |
groups_id | []int | [ 0, 1 ] | No | List of group IDs |
Request example
{
"limit": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": [
{
"id": 1,
"name": "New campaign1",
"type": "api_call",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag3",
"tag4"
],
"Groups": [
{
"Id": 1,
"Name": "subaccount"
}
]
},
{
"id": 2,
"name": "New campaign2",
"type": "api_call",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag1",
],
"Groups": [
{
"Id": 0,
"Name": "main"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 7
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |
id | int | Trigger campaign ID |
name | string | Campaign name |
type | string | Trigger type |
for_confirm | bool | Messages with opt-in links flag |
is_active | bool | Campaign active flag |
ui_tags | []String | Tag list |
groups | []String | Group list |