PodporaAPI dokumentace

mailkit.mailinglist.edituser

Funkce mailkit.mailinglist.edituser upraví stávajícího příjemce v seznamu.

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 Base 64. Parametry jsou rozděleny do několika větví, jejichž pořadí a existenci je nutné dodržet. Za parametrem s email_id je jeden prázdný parametr, jež je nutné zachovat kvůli zpětné kompatibilitě.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.mailinglist.edituser</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_user_list</int>
      </value>
    </param>
    <param>
      <value>
        <string>email_id</string>
      </value>
    </param>
    <param>
      <value>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>vocative</name>
            <value>
              <string>T3Nsb3ZlbsOt</string>
            </value>
          </member>
          <member>
            <name>prefix</name>
            <value>
              <string>VGl0dWw=</string>
            </value>
          </member>
          <member>
            <name>first_name</name>
            <value>
              <string>Sm3DqW5v</string>
            </value>
          </member>
          <member>
            <name>last_name</name>
            <value>
              <string>UMWZw61qbWVuw60=</string>
            </value>
          </member>
          <member>
            <name>status</name>
            <value>
              <string>ZW5hYmxlZA==</string>
            </value>
          </member>
          <member>
            <name>reply_to</name>
            <value>
              <string>ZXhhbXBsZUBleGFtcGxlLmN6</string>
            </value>
          </member>
          <member>
            <name>company</name>
            <value>
              <string>U3BvbGXEjW5vc3Q=</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>nick_name</name>
            <value>
              <string>UMWZZXpkw612a2E=</string>
            </value>
          </member>
          <member>
            <name>country</name>
            <value>
              <string>S3Jhag==</string>
            </value>
          </member>
          <member>
            <name>street</name>
            <value>
              <string>VWxpY2U=</string>
            </value>
          </member>
          <member>
            <name>state</name>
            <value>
              <string>WmVtxJs=</string>
            </value>
          </member>
          <member>
            <name>zip</name>
            <value>
              <string>UFPEjA==</string>
            </value>
          </member>
          <member>
            <name>city</name>
            <value>
              <string>TcSbc3Rv</string>
            </value>
          </member>
          <member>
            <name>mobile</name>
            <value>
              <string>bW9iaWw=</string>
            </value>
          </member>
          <member>
            <name>phone</name>
            <value>
              <string>VGVsZWZvbg==</string>
            </value>
          </member>
          <member>
            <name>fax</name>
            <value>
              <string>ZmF4</string>
            </value>
          </member>
          <member>
            <name>gender</name>
            <value>
              <string>Rg==</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>custom1</name>
            <value>
              <string>dmxhc3Ruw60gxI0uMQ==</string>
            </value>
          </member>
          <member>
            <name>custom25</name>
            <value>
              <string>dmxhc3Ruw60gxI0uMjU=</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

JSON

{
	"function": "mailkit.mailinglist.edituser",
	"id": "client_id",
	"md5": "client_md5",
	"parameters": {
		"ID_user_list": "123456",
		"ID_email": "123456789",
		"personal": {
			"first_name": "Sm3DqW5v",
            "last_name": "UMWZw61qbWVuw60=",
            "vocative": "T3Nsb3ZlbsOt",
            "prefix": "VGl0dWw=",
            "status": "ZW5hYmxlZA==",
			"reply_to": "ZXhhbXBsZUBleGFtcGxlLmN6",
			"company": "U3BvbGXEjW5vc3Q="
		},
		"address": {
            "zip": "UFPEjA==",
            "mobile": "bW9iaWw=",
            "fax": "ZmF4",
            "nick_name": "UMWZZXpkw612a2E=",
            "country": "S3Jhag==",
            "street": "VWxpY2U=",
            "state": "WmVtxJs=",
            "city": "TcSbc3Rv",
            "phone": "VGVsZWZvbg==",
            "gender": "Rg=="
        },
		"custom": {
			"custom1": "dmxhc3Ruw60gxI0uMQ==",
			"custom25": "dmxhc3Ruw60gxI0uMjU="
		}
	}
}

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.
ID_user_list * = ID seznamu příjemců
email_id * = může obsahovat buď konkrétní ID_emailu, nebo e-mailovou adresu

Jednotlivé níže uvedené parametry nejsou povinné. Pro vynulování hodnoty stačí zaslat pojmenovaný parametr s prázdnou hodnotou.

Větev "personal"

first_name (v Base 64) = jméno příjemce
last_name (v Base 64) = příjmení příjemce
company (v Base 64) = firma příjemce
prefix (v Base 64) = titul příjemce
vocative (v Base 64) = oslovení příjemce
reply_to (v Base 64) = e-mailová adresa pro odpověď příjemce
status (v Base 64) = stav příjemce. Stav může nabývat níže uvedených hodnot, jiné hodnoty jsou ignorovány.

  • enabled (stav aktivní)
  • unknown (stav neznámý)
  • temporary (stav dočasně nedostupný)
  • permanent (stav trvale nedostupný)

Větev "address"

nick_name (v Base 64) = přezdívka příjemce
gender (v Base 64) = pohlaví příjemce. Může nabývat hodnot male/female; m/f; muz/zena; M/F
phone (v Base 64) = telefon příjemce
mobile (v Base 64) = mobil příjemce
fax (v Base 64) = fax příjemce
street (v Base 64) = adresa (ulice) příjemce
city (v Base 64) = město příjemce
state (v Base 64) = země příjemce
country (v Base 64) = kraj příjemce
zip (v Base 64) = PSČ příjemce

Větev "custom"

custom1 (v Base 64) = vlastní pole příjemce č. 1. Celkový počet vlastních polí je 25.

* povinný parametr

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>data</name>
            <value>
              <string>OK</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "error_status": 0,
    "error": "OK",
    "ID_email": 1234567890
}

Hodnoty

data = OK = data o příjemci byla úspěšně změněna

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

XML

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

JSON

{
    "error": "Missing ID_mailing_list",
    "error_status": 1
}

Hodnoty

Missing ID_email = chybějící ID e-mailu / e-mail
Invalid_ID_email = neplatné ID e-mailu / e-mail
Missing ID_mailing_list = chybějící nebo neplané ID seznamu příjemců (XML-RPC)
Invalid ID_user_list = neplané ID seznamu příjemců (JSON)
Missing ID_user_list = chybějící ID seznamu příjemců (JSON)