Kontroler służy do tworzenia, sprawdzania i wysyłania kampanii.

Wywołanie:

POST /rest/campaigns/create

 

Dane w POST:

name	Wymagane	Nazwa kampanii
url	Opcjonalne	Adres strony z której ma zostać pobrany kod HTML
html	Wymagane*	Treść html emaila (wymagana jeśli nie ma treści text oraz adresu url ).
text	Wymagane*	Treść tekstowa emaila (wymagana jeśli nie ma treści html).
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	Wymagane*	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	Wymagane*	Hash grupy do której ma być wysłana kampania. Jeśli wysyłka będzie kierowana do więcej niż jednego segmentu odbiorców, może mieć postać tablicy (zestawu) hashy. 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

 

Zwracane dane:

hash	W przypadku poprawnego utworzenia kampanii zwrócony zostaje jej hash

 

Kody błędów:

1701	Brak nazwy kampanii
1702	Brak treści (nie podano treści text, html ani url )
1703	Błędny adres url
1704	Brak klienta (błąd wewnętrzny)
1705	Brak parametrów (błąd wewnętrzny)
1706	Błędny adres nadawcy (from_address)
1707	Błędny adres „reply to”
1708	Brak listy subskrypcyjnej i grupy
1709	Co najmniej jeden hash listy jest błędny.
1710	Co najmniej jeden hash grupy jest błędny.
1711	Nie znaleziono list o podanym hashu.
1712	Nie znaleziono grupy o podanym hashu.
1713	Link rezygnacji musi być poprawnym adresem URL