API call example:
JSON
{
"function":"mailkit.mailinglist.getstatus",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"status":"status",
"change_date":"YYYY-MM-DD HH:MM:SS",
"ID_user_list":"ID_user_list",
"ID_email":"ID_email",
"limit":"100",
"include_new": "FALSE"
}
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>mailkit.mailinglist.getstatus</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>mailinglist_id</int>
</value>
</param>
<param>
<value>
<string>status</string>
</value>
</param>
<param>
<value>
<string>change_date</string>
</value>
</param>
<param>
<value>
<string>ID_email</string>
</value>
</param>
<param>
<value>
<string>limit</string>
</value>
</param>
<param>
<value>
<string>include_new</string>
</value>
</param>
</params>
</methodCall>
Values
client_id * = client ID can be found in your Mailkit account's menu Profile/Integration.
client_md5 * = MD5 code can be found in your Mailkit account's menu Profile/Integration.
mailinglist_id * = ID of mailing list
status = recipient's status (optional). When used returns only e-mails with a given status. Possible values:
- enabled
- unknown
- temporary
- permanent
- unsubscribe
change_date = date of recipient's data last update (optional) in "yyyy-mm-dd hh:mm:ss" format. Returns only emails updated on a given date or newer.
ID_email = ID of the email address to start output from when itterating through records
limit = number of records to output (max. 10000)
include_new
- FALSE (default) = only emails with a change date greater than or equal to the date specified in the "change_date" parameter are included in the output. Emails that were newly added to the recipient list on or after the date defined in the "change_date" parameter but have not been updated will not be included in the output.
- TRUE = in addition to recipients that were updated on or after the date defined in the "change_date" parameter, new recipients that were added to the recipient list on or after this date but have not yet been updated will also be included.
* required value
Successful call response:
JSON
[
{
"CHANGE_DATE":"2016-03-17 10:42:35",
"CUSTOM_9":"yes",
"DATE":"2012-05-25 23:21:30",
"VOCATIVE":"Dear Sir",
"STATUS":"enabled",
"CUSTOM_8":"21A",
"CUSTOM_23":"",
"COMPANY":"",
"REPLY_TO":"",
"CUSTOM_15":"31.12.",
"CUSTOM_25":"",
"CUSTOM_5":"",
"ID_EMAIL":"123456789",
"FAX":"ne",
"MOBILE":"7771234565",
"CONSENT_DATE": "2022-01-22 14:38:26",
"CUSTOM_3":"1",
"SCORE": 5,
"PREFIX":"",
"CONSENT":"TRUE",
"CUSTOM_4":"13",
"ID_RECIPIENT":5544332211,
"EMAIL":"mail@mailmail.cz",
"CONSENT_CHANNEL": "subscribe insert",
"CUSTOM_2":"po",
"CUSTOM_12":"15-12-31",
"NICK_NAME":"Nicky",
"CUSTOM_14":"31.12.15",
"CUSTOM_18":"",
"COUNTRY":"",
"CITY":"Praha",
"LAST_NAME":"Smith",
"STREET":"ne",
"CUSTOM_7":"vlastní 7",
"CUSTOM_11":"2015-12-31",
"CUSTOM_16":"11",
"CUSTOM_19":"ano",
"GENDER":"M",
"TREND": 0,
"CUSTOM_6":"ne",
"CUSTOM_10":"2015-12-31",
"CUSTOM_1":"ano",
"CUSTOM_13":"31.12.2015",
"CUSTOM_20":"",
"CUSTOM_22":"",
"FIRST_NAME":"Robert",
"CUSTOM_24":"kočka",
"ZIP":"15000",
"CUSTOM_21":"",
"STATE":"ČR",
"CUSTOM_17":"Y",
"PHONE":"7771234567"
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>VOCATIVE</name>
<value>
<string>salutation</string>
</value>
</member>
<member>
<name>PREFIX</name>
<value>
<string>title</string>
</value>
</member>
<member>
<name>FIRST_NAME</name>
<value>
<string>first name</string>
</value>
</member>
<member>
<name>LAST_NAME</name>
<value>
<string>last name</string>
</value>
</member>
<member>
<name>NICK_NAME</name>
<value>
<string>nick</string>
</value>
</member>
<member>
<name>GENDER</name>
<value>
<string>F/M</string>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>example@example.cz</string>
</value>
</member>
<member>
<name>ID_EMAIL</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>ID_RECIPIENT</name>
<value>
<i4>269965799</i4>
</value>
</member>
<member>
<name>REPLY_TO</name>
<value>
<string>example2@example2.cz</string>
</value>
</member>
<member>
<name>PHONE</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>FAX</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>MOBILE</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>COMPANY</name>
<value>
<string>company</string>
</value>
</member>
<member>
<name>STREET</name>
<value>
<string>street</string>
</value>
</member>
<member>
<name>CITY</name>
<value>
<string>city</string>
</value>
</member>
<member>
<name>COUNTRY</name>
<value>
<string>country</string>
</value>
</member>
<member>
<name>ZIP</name>
<value>
<string>ZIP</string>
</value>
</member>
<member>
<name>STATE</name>
<value>
<string>state</string>
</value>
</member>
<member>
<name>DATE</name>
<value>
<string>yyyy-mm-dd hh:mm:ss</string>
</value>
</member>
<member>
<name>CHANGE_DATE</name>
<value>
<string>yyyy-mm-dd hh:mm:ss</string>
</value>
</member>
<member>
<name>CONSENT_CHANNEL</name>
<value>
<string>subscribe insert</string>
</value>
</member>
<member>
<name>CONSENT_DATE</name>
<value>
<string>2026-01-22 14:12:02</string>
</value>
</member>
<member>
<name>CONSENT</name>
<value>
<string>TRUE</string>
</value>
</member>
<member>
<name>STATUS</name>
<value>
<string>enabled</string>
</value>
</member>
<member>
<name>SCORE</name>
<value>
<string>3</string>
</value>
</member>
<member>
<name>TREND</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>CUSTOM_1</name>
<value>
<string>custom field n. 1</string>
</value>
</member>
<member>
<name>CUSTOM_2</name>
<value>
<string>custom field n. 2</string>
</value>
</member>
<member>
<name>CUSTOM_25</name>
<value>
<string>custom field n. 25</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
VOCATIVE = salutation of recipient
PREFIX = title of recipient
FIRST_NAME = first name of recipient
LAST_NAME = last name of recipient
NICK_NAME = nickname of recipient
GENDER = gender of of recipient. Possible values:
- F = female
- M = male
- empty field = no gender
EMAIL = email address of recipient
ID_EMAIL = unique ID of email address in a specific recipient list - this value is used for itteration through large lists
ID_RECIPIENT = unique recipient ID in Mailkit account
REPLY_TO = e-mail address of recipient for reply to
PHONE = phone number of recipient
FAX = mobile numer of recipient
MOBILE = mobil příjemce
COMPANY = company of recipient
STREET = street address of recipient
CITY = city of recipient
COUNTRY = country of recipient
ZIP = ZIP of recipient
STATE = state of recipient
DATE = date recipient was added to the list
CHANGE_DATE = date of recipient's data last update
CUSTOM_1 = custom field of recipient n. 1. Total number of custom fields is 25.
SCORE = recipient's engagement score
TREND = recipient's engagement trend
CONSENT = recipient consent record. Value of TRUE / FALSE.
CONSENT_DATE = date of consent (if consent exists)
CONSENT_CHANNEL = source of the consent. Values include:
- subscribe update (update of consent via subscribe form)
- rpc mailinglist.adduser (consent passed via API - mailkit.mailinglist.adduser)
- subscribe insert (consent confirmed using subscribe form)
- subscribe (previously stored consent)
- rpc email.revalidate (consent revalidated via API - mailkit.email.revalidate)
- confirm_url (consent confirmed using confirmation link from campaign)
STATUS = status of recipient. Possible values:
- enabled
- unknown
- temporary
- permanent
- unsubscribe
Unsuccessful call response:
JSON
{
"error_status": 1,
"error": "Invalid ID_user_list"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Values
Empty response - invalid status of recipient and/or no matching recipients
Invalid ID_user_list - invalid mailing list ID
Unknown status - invalid recipient status
Invalid change_date_format - invalid date of recipient's data last update
