Wysłanie kampanii

Wywołanie:

POST /rest/campaigns/edit

 

Dane w POST:

id_hash	Wymagane	Hash kampanii do edytowania
name	Opcjonalne	Nazwa kampanii
url	Opcjonalne	Adres strony z której ma zostać pobrany kod HTML
html	Opcjonalne	Treść html emaila
text	Opcjonalne	Treść tekstowa emaila
subject	Opcjonalne	Tytuł jaki ma mieć email wysłany przez system. W razie braku jako tytuł będzie wzięta nazwa kampanii.
from_address	Opcjonalne	Pole „Od”, jeśli będzie puste w to miejsce wstawi się domyślny adres nadawcy z systemu.
from_name	Opcjonalne	Pole „Nazwa nadawcy”, jeśli będzie puste w to miejsce wstawi się domyślna nazwa nadawcy z systemu.
reply_to	Opcjonalne	Pole „Odpowiedz do”, jeśli będzie puste w to miejsce wstawi się domyślny adres nadawcy z systemu.
list	Opcjonalne	Hash listy subskrypcyjnej do której ma być wysłana kampania. Może być to tablica hashy jeśli wysyłka będzie do więcej niż jedne listy. W przypadku wysyłki do grupy nie trzeba podawać listy.
group	Opcjonalne	Hash grupy do której ma być wysłana kampania. Może być to tablica hashy jeśli wysyłka będzie do więcej niż jedne grupy. W przypadku wysyłki do listy subskrypcyjnej nie trzeba podawać grupy.
resignlink	Opcjonalne	Adres URL na jaki zostanie przekierowany odbiorca po kliknięciu na link rezygnacji

 

 

Kody błędów:

1750	Brak kampanii do edycji o podanym hashu
1751	Kampania już została ustawiona do wysyłki, modyfikacja niemożliwa

Reszta kodów błędów jest identyczna jak w przypadku tworzenia kampanii.

Kasowanie kampanii

Wywołanie:
POST /rest/campaigns/delete

 

Dane w POST:

hash	Wymagane	Hash kampanii do skasowania

 

Kody błędów:

1724	Brak kampanii o takim hashu
1798	Kampania już została skasowana

Wysłanie kampanii testowej

Wywołanie:
POST /rest/campaigns/sendTest

 

Dane w POST:

hash	Wymagane	Hash kampanii którą chcemy wysłać
emails	Wymagane	Adres lub tablica adresów na które test ma być wysłany.
custom_fields	Opcjonalne	Tablica z polami dodatkowymi, w przypadku pozostawienia pola pustego wartości pól dodatkowych zostaną uzupełnione losowymi danymi z listy subskrypcyjnej

 

Przykładowy request:

{"hash":"hash_kampanii",
"emails":"test@test.pl",
"custom_fields":{
"imie":"Jan",
"nazwisko":"Kowalski"}}

 

lub

{"hash":"hash_kampanii",
"emails":["test1@test.pl","test2@test.pl"]}

 

Kody błędów:

1721	Brak hasha lub jest on niepoprawny.
1722	Brak adresu email.
1723	Co najmniej jeden adres email jest niepoprawny.
1724	Kampania o takim hashu nie istnieje.
1725	Kampania nie jest jeszcze gotowa do wysyłki testowej.
1726	Wysyłka nie powiodła się.
1737	Błąd treści kampanii. Dokładny opis błędu będzie zawarty w informacji zwróconej przez api

Wysłanie kampanii

Wywołanie:
POST /rest/campaigns/send

 

Dane w POST:

hash	Wymagane	Hash kampanii którą chcemy wysłać
time	Opcjonalne	Data wysłania kampanii w formacie YYYY-MM-DD H:i:s

 

Kody błędów:

1731	Brak hasha lub jest on niepoprawny.
1732	Czas wysyłki jest niepoprawny
1733	Czas wysyłki nie może być wcześniejszy niż obecna godzina.
1734	Kampania o takim hashu nie istnieje.
1735	Kampania nie jest jeszcze gotowa do wysyłki testowej.
1736	Kampania już jest ustawiona do wysyłki lub jest w jej trakcie.
1737	Błąd treści kampanii. Dokładny opis błędu będzie zawarty w informacji zwróconej przez api