ResourcesAPI documentation

mailkit.campaigns.list

Function mailkit.campaigns.list returns a list of available campaigns with details about their delivery scheduling and settings.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.campaigns.list</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_message</int>
      </value>
    </param>
  </params>
</methodCall>

JSON

{  
   "id":"client_id",
   "md5":"client_md5",
   "function":"mailkit.campaigns.list",
   "ID_message":12345
}

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

ID_message = ID of campaign (optional). When used returns only campaign with a given ID.

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>Name of campaign</string>
                  </value>
                </member>
                <member>
                  <name>ID_MESSAGE</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>SUBJECT</name>
                  <value>
                    <string>Subject of campaign</string>
                  </value>
                </member>
                <member>
                  <name>SUBJECT_B</name>
                  <value>
                    <string>Subject of campaign</string>
                  </value>
                </member>
                <member>
                  <name>USER_LIST</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>LAST_SENT</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>TYPE</name>
                  <value>
                    <string>single</string>
                  </value>
                </member>
                <member>
                  <name>REPEAT</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>REPEAT_COUNT</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>DAYS</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>TIME_ZONE</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>PERIOD</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>SEND_DATE</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>MSG_TYPE</name>
                  <value>
                    <string>email</string>
                  </value>
                </member>
                <member>
                  <name>CAMPAIGN_TYPE</name>
                  <value>
                    <string>normal</string>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <string>enabled</string>
                  </value>
                </member>
                <member>
                  <name>TEST_MODE</name>
                  <value>
                    <boolean>FALSE</boolean>
                  </value>
                </member>
                <member>
                  <name>USE_AB</name>
                  <value>
                    <boolean>FALSE</boolean>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[
    {
        "NAME": "Name of campaigns",
        "ID_MESSAGE": 12345,
        "SUBJECT": "Campaign subject",
        "SUBJECT_B": "Campaign subject version B",
        "MSG_TYPE": "email",
        "CAMPAIGN_TYPE": "normal",
        "USE_AB": false,
        "TEST_MODE": true,
        "SEND_DATE": "2020-12-31 00:00:01",
        "TIME_ZONE": "Europe/Prague",
        "LAST_SENT": "2020-08-31 14:15:24",
        "REPEAT": false,
        "REPEAT_COUNT": 1,
        "PERIOD": "week",
        "DAYS": "1,3,7"
        "STATUS": "enabled",
        "TYPE": "single",
        "TEST_MODE": false,
        "USER_LIST": [
            123,
            456
        ]
    }
]

Values

NAME = name of campaign
ID_MESSAGE = ID of campaign
SUBJECT = subject of campaign
SUBJECT_B = campaign B version subject
USER_LIST = ID of mailing list / lists assigned to the campaign. (ID of mailing lists are comma separated)
LAST_SENT = last sent date of campaign. (yyyy-mm-dd hh:mm:ss)
TYPE = type of last campaign's delivery

  • immediate = immediate delivery of campaign
  • single = an unattended delivery of campaign
  • multiple = recurring unattended campaign delivery

REPEAT = can be TRUE in case the campaign is set for recurring delivery
REPEAT_COUNT = the interval of the recurring schedule. Values 1 to x
DAYS = on what days will the campaign delivery occur (when set for recurring campaign delivery). Returns values: 1 - 7 (1= monday, 7= sunday)
TIME_ZONE = time zone (when set for unattended delivery). Possible values: -12:00 (as UTC-12) to 12:00 (as UTC+12)
PERIOD = period of recurring campaign delivery

  • week = weekly
  • month = monthly

SEND_DATE = date of scheduled unattended delivery (yyyy-mm-dd hh:mm:ss)
MSG_TYPE = type of message (email, sms, wpush, apush)
CAMPAIGN_TYPE = type of campaign (normal, remarketing)
STATUS = campaign status (enabled,disabled)
TEST_MODE = whether the campaign is in test mode (true/false)
USE_AB = whether the campaign has A/B testing enabled (true/false)