ResourcesAPI documentation

mailkit.email.revalidate

Function mailkit.email.revalidate is used to revalidate (re-subscribe) previously unsubscribed recipient.

As of 31 December 2020, this function will be abolished in favor of the mailkit.mailinglist.adduser function, which provides unified method for adding subscribers to the mailing list as well as for reactivating unsubscribed recipients and enables complete parameterization of the confirmation process.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.revalidate</methodName>
  <params>
    <param>
    <value>
      <int>client_id</int>
    </value>
    </param>
    <param>
    <value>
      <string>client_md5</string>
    </value>
    </param>
    <param>
    <value>
      <int>ID_email</int>
    </value>
    </param>
    <param>
    <value>
      <int>ID_message</int>
    </value>
    </param>
    <param>
    <value>
      <boolean>agreement</boolean>
    </value>
    </param>
    <param>
    <value>
      <string>channel</string>
    </value>
    </param>
    <param>
    <value>
      <int>dummy</int>
    </value>
    </param>
    <param>
    <value>
      <string>language</string>
    </value>
    </param>
  </params>
</methodCall>
		

JSON

{  
   "id":"client_id",
   "md5":"client_md5",
   "function":"mailkit.email.revalidate",
   "parameters":{  
      "email":"email",
      "language":"CZ",
      "ID_message":"ID_message",
      "ID_email":"ID_email",
      "channel":"channel",
      "agreement":"FALSE"
   }
}

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_email * = provide ID of e-mail address, (returned by mailkit.mailinglist.adduser), or e-mail address
email * = email address (JSON only) the parameter email or ID_email can be used.
ID_message = ID of campaign (optional), the template subscribe email file assigned to this campaign will be used as a base of the validation email sent to recipient.
ID_template = ID template (optional in JSON only) - template's subscribe email file will be used as a base of the validation email sent to recipient.
agreement * = possible values TRUE / FALSE

  • TRUE = recipient provided consent with re-listing in the mailing list. No opt-in confirmation will be sent. Channel param should contain the information regarding the opt-in method used (eg.mail, phone)
  • FALSE = an email with an opt-in confirmation link will be sent to the recipient and the recipient will be relisted after clicking the verification link

channel = channel used for obtaining the recipient's consent. In case the consent value is FALSE, the IP address will be recorder at the time the consent is confirmed.
dummy = empty value for backwards compatibility (XML-RPC only)
language = language for the opt-in confirmation email containing the verification link. Possible values: cs,en,de,ru,pl,sk,hu

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>example@example.cz</string>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "email": "email@example.com",
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Sent subscribe email"
}

Values

e-mail = email address has been revalidated / an email with opt-in confirmation link has been sent (XML)

Sent subscribe email = an email with opt-in confirmation link has been sent (JSON)
Email has been revalidated = e-mail has been revalidated (JSON)

Unsuccessful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>example@example.cz is not unsubscribed</string>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Email is not unsubscribed",
    "email": "sample@samplemail.com"
}

Values

Email is not unsubscribed = email in not unsubcribed and therefore can't be revalidated