PodporaAPI dokumentace

mailkit.campaigns.update

Funkce mailkit.campaigns.update aktualizuje či změní existující kampaň.

XML-RPC žádost musí být vydána ve formátu uvedeném níže.
UPOZORNĚNÍ: Formát zasílaných dat musí být v Base64.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
 <methodName>mailkit.campaigns.update</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <string>ID_message</string>
   </value>
  </param>
  <param>
   <value>
    <string>update (true/false)</string>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>name</name>
      <value>
       <string>bmFtZQ==</string>
      </value>
     </member>
     <member>
      <name>subject</name>
      <value>
       <string>c3ViamVjdA==</string>
      </value>
     </member>
     <member>
      <name>ID_allow_email</name>
      <value>
       <string>MTIzNDU2</string>
      </value>
     </member>
     <member>
      <name>type_send</name>
      <value>
       <string>dHh0aHRtbA==</string>
      </value>
     </member>
     <member>
      <name>generate_txt</name>
      <value>
       <string>dHJ1ZQ==</string>
      </value>
     </member>
     <member>
      <name>ID_mailing_list</name>
      <value>
       <string>MTIzNDU2</string>
      </value>
     </member>
     <member>
      <name>ID_delivery_feed</name>
      <value>
       <string></string>
      </value>
     </member>
     <member>
      <name>ID_query</name>
      <value>
       <string>MTIzNDU2</string>
      </value>
     </member>
     <member>
      <name>ID_template</name>
      <value>
       <string>MTIzNDU2</string>
      </value>
     </member>
     <member>
      <name>google_analytics</name>
      <value>
       <string>VFJVRQ==</string>
      </value>
     </member>
     <member>
      <name>analytic_name</name>
      <value>
       <string>bmFtZQ==</string>
      </value>
     </member>
     <member>
      <name>content</name>
      <value>
       <string>CjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW5zaXRpb25h 
        bC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9u 
        YWwuZHRkIj4KPGh0bWw+CjxoZWFkPgo8L2hlYWQ+Cjxib2R5PgpKbWVubzogW0ZJUlNUX05BTUVd 
        PGJyPgpQcmlqbWVuaTogW0xBU1RfTkFNRV0KPC9ib2R5Pgo8L2h0bWw+ICAgIAo=</string>
      </value>
     </member>
     <member>
      <name>content2</name>
      <value>
       <string>CjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW5zaXRpb25h 
        bC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9u 
        YWwuZHRkIj4KPGh0bWw+CjxoZWFkPgo8L2hlYWQ+Cjxib2R5PgpKbWVubzogW0ZJUlNUX05BTUVd 
        PGJyPgpQcmlqbWVuaTogW0xBU1RfTkFNRV0KPC9ib2R5Pgo8L2h0bWw+ICAgIAo=</string>
      </value>
     </member>
     <member>
      <name>content_txt</name>
      <value>
       <string></string>
      </value>
     </member>
     <member>
      <name>reply_to</name>
      <value>
       <string>ZW1haWxAZW1haWwuY3o=</string>
      </value>
     </member>
     <member>
      <name>unsubscribe_email</name>
      <value>
       <string>ZW1haWxAZW1haWwuY3o=</string>
      </value>
     </member>
     <member>
      <name>web_template</name>
      <value>
       <string>ZmFsc2U=</string>
      </value>
     </member>
     <member>
      <name>style_inline</name>
      <value>
       <string>ZmFsc2U=</string>
      </value>
     </member>
     <member>
      <name>ID_unsubscribe_group</name>
      <value>
       <string></string>
      </value>
     </member>
    </struct>
   </value>
  </param>
  ---nastavení AB testu, B verze kampaně---
  <param>
   <value>
    <struct>
     <member>
      <name>generate_txt</name>
      <value>
       <string>dHJ1ZQ==</string>
      </value>
     </member>
     <member>
      <name>subject</name>
      <value>
       <string>c3ViamVjdA==</string>
      </value>
     </member>
     <member>
      <name>content</name>
      <value>
       <string></string>
      </value>
     </member>
     <member>
      <name>content2</name>
      <value>
       <string></string>
      </value>
     </member>
     <member>
      <name>ID_allow_email</name>
      <value>
       <string>MTIzNDU2</string>
      </value>
     </member>
     <member>
      <name>ab_percentage</name>
      <value>
       <string>MjA=</string>
      </value>
     </member>
     <member>
      <name>ab_evalution</name>
      <value>
       <string>b3Blbg==</string>
      </value>
     </member>
     <member>
      <name>ab_evalution_time</name>
      <value>
       <string>NGg=</string>
      </value>
     </member>
    </struct>
   </value>
  </param>
  ------
</params>
</methodCall>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.

client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.

update *:

  • true = nevyplněné parametry se nastaví jako defaultní
  • false = nevyplněné parametry se nezmění

name (v base64) * = jméno kampaně

subject (v base64) * = předmět kampaně

ID_allow_email (v base64) * = ID odesílacího e-mailu

type_send (v base64) = formát zprávy

  • html = pro HTML formát​​​​​​​
  • txthtml = pro kombinaci HTML a TXT​​​​​​​
  • txt = pro TXT formát

generate_txt (v base64) = automatické generování prostého textu z HTML

  • true = automatické generování zapnuto​​​​​​​
  • false = automatické generování vypnuto

ID_mailing_list (v base64) = ID seznamu příjemců. V případě více seznamů jsou jednotlivá ID oddělena čárkou.

ID_delivery_feed = ID doručovacího zdroje (delivery feedu). Ke kampani může být připojen buď pouze seznam(y) příjemců, nebo delivery feed.

ID_template (v base64) = ID šablony

ID_query (v base64) = ID podmínky (pouze v kombinaci se seznamem příjemců)

google_analytics (v base64) = automatické vkládání utm parametrů Google Analytics k odkazům

  • true = zapnuto​​​​​​​
  • false = vypnuto

analytics_name (v base64) = název kampaně pro Google Analytics

content (v base64) = obsah 1

content2 (v base64) = obsah 2. Maximální počet obsahů je 10.

content_txt (v base64) = obsah v TXT formátu. Pouze v případě, že je vypnuté automatické generování TXT verze, nebo je e-mail čistě v TXT formátu.

reply_to (v base64) = e-mailová adresa pro odpovědi

unsubscribe_email (v base64) = e-mailová adresa, kam se mají zasílat informace o odhlášení

web_template (v base64) = použití microsite

  • true = zapnuto​​​​​​​
  • false = vypnuto

style_inline (v base64) = prevedení CSS stylů do inline

  • true = zapnuto​​​​​​​
  • false = vypnuto

ID_unsubscribe_group (v base64) = ID téma kampaně

ab_percentage (v base64) = testovací skupina AB testu v procentech (1 - 99)

ab_evalution (v base64) = vyhodnocení AB testu dle (open|click|conversion|ctr)

ab_evalution_time (v base64) = doba pro vyhodnocení AB testu (1h - 23h, 1d - 4d)

* povinný parametr

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

XML

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

Hodnoty

ID aktualizované kampaně

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Missing allow email</string>
      </value>
    </param>
  </params>
</methodResponse>
		

Hodnoty

Missing allow email = chybí odesílací e-mail

error: status, (xxx) = odesílací e-mail není ověřený | byl uveden ve špatném formátu | nemá platné SPF atp.

Missing name of campaign = chybí název kampaně

Wrong ID_message = neplatné ID kampaně

Missing subject of campaign = chybí předmět kampaně

Wrong ID_template = neplatná šablona

Confused parameters = je možné použít buď seznam příjemců, nebo delivery feed, nikoliv jejich kombinace

Invalid ID_query = neplatná ID query

Invalid ID_delivery_feed = neplatný delivery feed