Get campaign information

Description

Retrieves detailed campaign information.

Request URL

Method: POST

https://example.com/api/v1.1/campaigns/get

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
id	int	1	Yes	Campaign ID

Request example

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>2</id>
</xml>

Response example

JSON

{
    "data": {
        "id": 118,
        "name": "Daily weather notification",
        "description": "",
        "type": "regular",
        "updated_user": "roman",
        "update_time": "2024-05-20T09:17:53.362Z",
        "is_active": false,
        "is_completed": false,
        "data_id": 1,
        "data_type": "list",
        "content": [
            {
                "subject": "",
                "from_email": "",
                "from_name": "",
                "replyto_email": "",
                "replyto_name": "",
                "message_id": 21
            }
        ],
        "status": "Inactive",
        "subid": "",
        "virtual_sender_id": 2,
        "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",
            "android-huawei",
            "ios-huawei",
            "android-rustore"
        ],
        "push_sending_mode": "fanout",
        "resource_id": 26,
        "channel": "push",
        "for_confirm": false
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <id>118</id>
        <name>Daily weather notification</name>
        <description></description>
        <type>regular</type>
        <updated_user>roman</updated_user>
        <update_time>2024-05-20T09:17:53.362Z</update_time>
        <is_active>false</is_active>
        <is_completed>false</is_completed>
        <data_id>1</data_id>
        <data_type>list</data_type>
        <content>
            <subject></subject>
            <from_email></from_email>
            <from_name></from_name>
            <replyto_email></replyto_email>
            <replyto_name></replyto_name>
            <message_id>21</message_id>
        </content>
        <status>Inactive</status>
        <subid></subid>
        <virtual_sender_id>2</virtual_sender_id>
        <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>android-huawei</providers>
        <providers>ios-huawei</providers>
        <providers>android-rustore</providers>
        <push_sending_mode>fanout</push_sending_mode>
        <resource_id>26</resource_id>
        <channel>push</channel>
        <for_confirm>false</for_confirm>
    </data>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameters	Type	Description
error	int	Error code
error_text	string	Error text
content	JSON array	Message templates list
data_id	int	Audience source ID
data_type	string	Audience source type
id	int	Campaign ID
update_time	string	Date the campaign was last edited
updated_user	string	Name of the user who edited the campaign
is_active	bool	Campaign active flag
is_completed	bool	Campaign finished flag
name	string	Campaign name
resource_id	int	Resource ID
send_email_content	bool	Email channel active
send_push_content	bool	Push channel active
send_sms_content	bool	SMS channel active
push_sending_mode	string	Push notification sending mode (push channels only)
for_confirm	bool	Messages with opt-in link flag
status	string	Campaign status
subid	string	Campaign SubID
type	string	Campaign type
virtual_sender_id	int	Virtual sender ID
descr	string	Campaign description
attributes	object	Attributes assigned to the campaign and their values