mailkit.email.unsubscribe

Funkce mailkit.email.unsubscribe odhlásí příjemce.

Ukázka API volání:

JSON 

{ 
   "function":"mailkit.email.unsubscribe",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
      "send_optout":"FALSE",
      "email":"email@example.eu",
      "ID_email":null,
      "ID_send_message":"",
      "timeout":"true",
      "timeout_days":"60"
   }
}

XML 

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.unsubscribe</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_send_message</int>
      </value>
    </param>
    <param>
      <value>
        <boolean>send_optout</boolean>
      </value>
    </param>
    <param>
     <value>
      <struct>
       <member>
        <name>timeout</name>
        <value>
         <boolean>1</boolean>
        </value>
       </member>
       <member>
        <name>timeout_days</name>
        <value>
         <int>60</int>
        </value>
       </member>
      </struct>
     </value>
   </param>
  </params>
</methodCall>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_email * = ID e-mailu, který má být odhlášen. Pro XML volání může obsahovat buď konkrétní ID e-mailu, nebo e-mailovou adresu. Pokud chcete odhlásit telefonní číslo, je potřeba jej zadat v mezinárodním formátu bez mezer (např. +420XXXXXXXXX)
email * = e-mailová adresa/telefonní číslo v mezinárodním formátu bez mezer (např. +420XXXXXXXXX), která/é má být odhlášena/o. Pouze pro JSON.
V JSON volání musí být použity oba parametry - email i ID_email, ale jeden z nich může mít nulovou hodnotu.
ID_send_message = ID konkrétní rozesílky. Volitelný parametr. Při jeho použití bude odhlášení příjemce zaznamenáno právě k dané rozesílce.
send_optout = může nabývat hodnot TRUE / FALSE

  • TRUE = příjemci bude zaslán e-mail s potvrzením o odhlášení (výchozí hodnota)
  • FALSE = příjemci nebude zaslán e-mail s potvrzením o odhlášení

timeout = aktivování dočasného odhlášení (pozastavení odběru zpráv). Může nabývat hodnot TRUE / FALSE.
timeout_days = počet dní do timeoutu dočasného odhlášení, tzn. za kolik dní příjemce bude moci opět dostávat zprávy. Může nabývat hodnot 14 až 90.
* povinný parametr

Po úspěšném volání se vrací:

JSON 

{
    "error_status": "0",
    "ID_email": "123456789",
    "status": "1"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <i4>282837490</i4>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

JSON response vrací:
ID_email – ID odhlášeného e-mailu nebo e-mailová adresa/telefonní číslo (to v případě, že se odhlašovaný e-mail v účtu nevyskytoval)
error_status – kód návratové chyby
status – 1 (příjemce úspěšně odhlášen), 2 (příjemce již byl odhlášen)

XML response vrací pouze ID odhlášeného e-mailu nebo e-mailovou adresu/telefonní číslo (to v případě, že se odhlašovaný e-mail v účtu nevyskytoval).

Příklad neúspěšného volání:

JSON 

{  
   "error_status":1,
   "error":"Missing ID_email or email"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Invalid ID_email or email</string>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

Invalid ID_email or email = e-mailová adresa/telefonní číslo má špatný formát / ID email pro daný účet neexistuje

Missing ID_email = chybějící e-mail/ID e-mailové adresy
Invalid timeout_days = nesprávný počet dní do timeoutu dočasného odhlášení (např. při hodnotě vyšší než 90)