Get trigger mailings list

Description

Retrieves trigger mailings 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 mailing in response ID. By default – 1
limit	int	10	No	Trigger mailings list limit. By default – 1000
format	string	"json"	No	Response data format. By default – json
is_active	bool	true	No	Retrieve only active mailings
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
attributes	object	{"season": {"options": ["spring_2024", "summer_2024"]}}	No	Attributes and their values for search

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz", 
    "limit": 2
}

XML

<xml>
   <token>abcdefghijklmnqrstuvwxyz</token>
   <limit>2</limit>
</xml>

Response example

JSON

{
    "data": [
        {
            "id": 12,
            "name": "New trigger mailing 3",
            "type": "api_call",
            "is_active": true,
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        },
        {
            "id": 14,
            "name": "New planetary mailing",
            "type": "api_call",
            "is_active": true,
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 1,
                    "name": "subaccount"
                }
            ],
            "providers": [
                "google",
                "mozilla",
                "safari",
                "safari-native",
                "firefox-firebase",
                "chrome-firebase",
                "opera-firebase",
                "yandex-firebase",
                "samsung-firebase",
                "android-firebase",
                "ios-firebase",
                "ios-apns",
                "yandex-Appmetrica-device-id-ios",
                "yandex-Appmetrica-device-id-android",
                "yandex-Appmetrica-ios-ifa",
                "yandex-Appmetrica-google-aid",
                "yandex-Appmetrica-android-token",
                "yandex-Appmetrica-ios-token",
                "mr",
                "android-huawei",
                "ios-huawei",
                "android-rustore"
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 41
}

XML

<xml>
    <data>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
        <id>12</id>
        <is_active>true</is_active>
        <name>New trigger mailing 3</name>
        <type>api_call</type>
        <ui_tags/>
    </data>
    <data>
        <for_confirm>false</for_confirm>
        <groups>
            <id>1</id>
            <name>subaccount</name>
        </groups>
        <id>14</id>
        <is_active>true</is_active>
        <name>New planetary mailing</name>
        <providers>google</providers>
        <providers>mozilla</providers>
        <providers>safari</providers>
        <providers>safari-native</providers>
        <providers>firefox-firebase</providers>
        <providers>chrome-firebase</providers>
        <providers>opera-firebase</providers>
        <providers>yandex-firebase</providers>
        <providers>samsung-firebase</providers>
        <providers>android-firebase</providers>
        <providers>ios-firebase</providers>
        <providers>ios-apns</providers>
        <providers>yandex-Appmetrica-device-id-ios</providers>
        <providers>yandex-Appmetrica-device-id-android</providers>
        <providers>yandex-Appmetrica-ios-ifa</providers>
        <providers>yandex-Appmetrica-google-aid</providers>
        <providers>yandex-Appmetrica-android-token</providers>
        <providers>yandex-Appmetrica-ios-token</providers>
        <providers>mr</providers>
        <providers>android-huawei</providers>
        <providers>ios-huawei</providers>
        <providers>android-rustore</providers>
        <type>api_call</type>
        <ui_tags/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>41</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Trigger mailing ID
name	string	Mailing name
type	string	Trigger type
for_confirm	bool	Messages with opt-in links flag
is_active	bool	Mailing active flag
ui_tags	[]String	Tag list
groups	[]String	Group list