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>test_mode</name>
      <value>
       <string>VFJVRQ==</string>
      </value>
     </member>
     <member>
      <name>test_emails</name>
      <value>
       <string>dGVzdEBlbWFpbGRlbW9zLmNvbQ==</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>ID_tagset</name>
      <value>
       <string>MTIz</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>

JSON

{
	"function": "mailkit.campaigns.update",
	"id": "cleint_id",
	"md5": "client_md5",
	"ID_message":"ID kampaně",
	"update":"true|false",
	"parameters": {
		"name": "název kampaně",
		"subject": "předmět",
		"ID_allow_email": "ID odesílací adresy",
		"ID_mailing_list":"ID seznamu příjemců",
		"ID_delivery_feed":"ID datového zdroje delivery feedu",
		"ID_query":"ID pravidla",
		"ID_template":"ID šablony",
		"google_analytics":"true|false",
		"analytic_name":"název pro analytics",
		"ID_tagset":"ID sady tagování",
		"test_mode":"true|false",
		"test_emails":"čárkou oddělený seznam e-mailových adres",
		"content":"obsah 1",
		"content2":"obsah 2",
		"content3":"obsah 3",
		"content4":"obsah 4",
		"content5":"obsah 5",
		"content6":"obsah 6",
		"content7":"obsah 7",
		"content8":"obsah 8",
		"content9":"obsah 9",
		"content10":"obsah 10",
		"reply_to":"email@domain.com",
		"unsubscribe_email":"email@domain.com",
		"web_template":"true|false",
		"style_inline":"true|false",
		"ID_unsubscribe_group":"ID tématu"
	},
	"ab_version":{
		"subject":"předmět B verze",
		"content":"obsah 1 B",
		"content2":"obsah 2 B",
		"ID_allow_email":"ID odesílací adresy",
		"ID_template":"ID šablony",
		"ab_percentage":"1-99",
		"ab_evaluation":"open|click|conversion|ctr",
		"ab_evaluation_time":"1h-4d"
	}
}

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ů)

test_mode (Base64) = testovací režim kampaně

  • true = zapnuto
  • false = vypnuto

test_emails (Base64) = čárkou/středníkem oddělený seznam emailových adres pro testovací režim (max. 10 adres)

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

ID_tagset (v base64) = ID sady pro trackování odkazů

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>
		

JSON

{
    "message": "Campaign 123456789 updated",
    "error_status": 0,
    "ID_message": "123456789"
}

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>
		

JSON

{
    "error": "Missing name of campaign",
    "error_status": 1,
    "error_code": 1
}

Hodnoty

Missing name of campaign (error_code:1) = chybí název kampaně
Missing subject of campaign (error_code:2/52 for B ver) = chybí předmět kampaně
Missing ID allow email (error_code:3/53 for B ver) = chybí ID_allow_email

error allow email: ID, status, auth (error_code:4/54 for B ver) = zvolené ID odesílací adresy není možné použít (odesílací adresa není korektně nakonfigurována)
Wrong ID_template (error_code:5/55 for B ver) = uvedené ID šablony není platné
Invalid ID_query (error_code:6) = Požadované ID podmínky není platné
Wrong ID_query (error_code: 7) =Požadované ID podmínky nelze použít
Invalid ID_delivery_feed (error_code: 8) = Požadovaný delivery feed neexistuje nebo se nejedná o datový zdroj doručování.
No valid emails provided in test_emails param (error_code: 9) = Prázdný nebo neplatný seznam adres
Invalid tagset ID (error_code: 10) = Požadovaná tagovací sada neexistuje
Wrong ID_mailing_list (error_code: 11) = Neplatné ID seznamu příjemců
Confused parameters - it is not possible to combine mailing lists and delivery feeds (error_code: 12) = Požadavek obsahuje nepřípustnou kombinaci ID seznamu příjemců a ID delivery feedu
Confused parameters - it is not possible to combine delivery capping and delivery feeds (error_code: 13) = Požadavek obsahuje nepřipustnou kombinace ID delivery feedu a ID podmínky doručení
Content failed to save (error_code: 14) = Při ukládání obsahu kampaně nastala chyba
Missing ID_message (error_code:15) = Chybí ID kampaně
Wrong ID_message (error_code: 16) = Neplatné ID kampaně
Missing ab percentage (error_code: 82) = Chybí hodnota procenta testovací skupiny AB testu
Wrong ab percentage (error_code: 83) = Neplatná hodnota velikosti testovací skupiny AB testu
Wrong ab evalution (error_code: 81) = Neplatné pravidlo vyhodnocení AB testu
Wrong ab evalution time (error_code: 81) = Neplatný čas pro vyhodnocení AB testu