Technická podpora


API: Update

Nastavení kampaně, aktualizace

Toto volání změní parametry kampaně, zejména:
aktivuje/deaktivuje kampaň
předá informace pro obsluhu rozhraní na straně ESP (API klíč, jméno, heslo, výchozí nastavení apod.)
změní obsah pop-upu
změní designovou variantu


Adresa požadavku

https://api.mailocator.com/1.0/update/




Příklad požadavku

Modře označené parametry jsou povinné, ostatní nejsou vyžadovány.

{
  mode: 'test',
  apiKey: 'XFG8-JUj4557m-7875478a',
  espID: '123abcd#esp',
  active: 1,
  lang: 'en',
  design: 'dark',
  title: 'Stay informed!',
  text: 'We would like to inform you about hot news',
  submit: 'Send',
  placeholder: 'enter your email here',
  disclaimer: 'See our privacy policy <a href="/disclaimer.html">here</a>',
  ESP:[
    {
      name: "Mailkit",
      APIkey: "abcd123456789",
      Option_1: "true",
      Option_1: "false",
      ...
    }
  ]
}





Hodnoty je třeba před odesláním zakódovat algoritmem Base64.



Seznam odeslaných hodnot

Vrácené hodnoty po úspěšném požadavku

active
1 | 0
Použijte 1, pokud má být kampaň aktivní


lang
ISO language shortcut
Nastavení jazyka podle označení ISO


design
light | dark
Určení barevné varianty (světlá / tmavá)


title
Text, max. 100 chars
Titulek pop-upu


text
Text, max. 200 chars
Sdělení pop-upu


submit
Text, max. 50 chars
Text potvrzovacího tlačítka


placeholder
Text, max. 50 chars
Text pole pro zadání e-mailové adresy


disclaimer
Text, max. 200 chars
Informace o nakládání s osobními daty


ESP
Object
Struktura informací pro připojení a předání dat směrem k ESP.
Struktura liší s každým ESP, konkrétní informace si prosím vyžádejte na support@mailocator.com







Seznam vrácených hodnot

Vrácené hodnoty po úspěšném požadavku

status
1 | 0
vrací 1, pokud je volání úspěšné a změny byly uloženy


statusText
Text
Komentář k výsledku, popis chyby


URL
URL address
Odkaz na náhled pop-upu