Listy odbiorców – zarządzanie

Kontroler służy do zarządzania listami subskrypcyjnymi. Umożliwia ich dodawanie, modyfikowanie, listowanie oraz usuwanie.

Tworzenie list

Funkcja służy do tworzenia list subskrypcyjnych. Zwraca hash listy, którym można się dalej posługiwać.

Wywołanie:

/rest/subscribers_list/create

 

Dane:

  name Wymagane  Nazwa listy subskrypcyjnej
  description Opcjonalne Opis listy subskrypcyjnej
  custom_fields Opcjonalne Tablica definiująca pola dodatkowe (wedle opisu z punktu Tworzenie pól dodatkowych w listach)

 

Zwracane dane:

  hash Hash nowej listy subskrypcyjnej
  custom_fields Tablica z pełnymi opisami utworzonych pól – jeśli miały być utworzone.

 

Kody błędów:

  1601 Pusta wartość w polu name
  1602 Nie udało się utworzyć listy subskrypcyjnej
  1603 Błędna lista pól dodatkowych.
  1604 Tag personalizacji powinien składać się jedynie z liter, cyfr i znaku podkreślenia.
  1605 Nieprawidłowy typ pola.

Modyfikowanie list

Funkcja służy do modyfikowania list subskrypcyjnych.

Wywołanie:

/rest/subscribers_list/update

 

Dane:

  hash Wymagane  Hash listy subskrybcyjnej
  name Wymagane Nazwa listy subskrypcyjnej
  description Opcjonalne Opis listy subskrypcyjnej

 

Kody błędów:

  1611 Pusta wartość w polu name lub brak parametru name
  1604 Brak uprawnień do listy

Usuwanie list

Funkcja służy do usuwania list subskrypcyjnych.

Wywołanie:

/rest/subscribers_list/delete

 

Dane:

  hash Wymagane  Hash listy subskrybcyjnej

 

Kody błędów:

  1604 Brak uprawnień do listy
  1605 Nie udało się usunąć listy subskrypcyjnej

Pobieranie danych o listach

Funkcja służy do listowania wszystkich list subskrypcyjnych. Zwraca tablice z danymi wszystkich list do których konto ma uprawnienia.

Wywołanie:

/rest/subscribers_list/lists

 

Zwracane dane:

  hash Hash listy subskrypcyjnej
  name Nazwa listy subskrypcyjnej
  description Opis listy subskrypcyjnej
  creation_date Data utworzenia listy subskrypcyjnej
  subscribers_number Liczba aktywnych subskrybentów

Tworzenie pól dodatkowych w listach

Funkcja służy do tworzenia pól dodatkowych w listach subskrypcyjnych

Wywołanie:

/rest/subscribers_list/addField

 

Dane:

  hash Wymagane  Hash listy subskrybcyjnej
  name Wymagane Nazwa pola w liście
  tag Opcjonalne Tag pod którym wartości z tego pola będą dostępne w mailach (w przypadku braku jest tworzony na podstawie nazwy pola)
  type Opcjonalne Typ pola – 0 tekstowe, 1 numeryczne (domyślnie tekstowe)

 

Zwracane dane:

  id_hash Hash pola dodatkowego
  field_name Nazwa pola dodatkowego
  personalization_tag Tag pod którym wartości z tego pola będą dostępne w mailach
  field_type Typ pola 0 – tekstowe, 1 - numeryczne

 

Kody błędów:

  1622 Błędny lub pusty hash listy subskrypcyjnej
  1623 Błędna lub pusta nazwa pola
  1624 Błędna nazwa tagu
  1625 Błędny typ pola
  1626 Pole dodatkowe o takim tagu personalizacji już istnieje

Wyświetlenie listy pól dodatkowych w podanej liście

Funkcja służy do wyświetlenia wszystkich pól dodatkowych w wybranej liście subskrypcyjnej

Wywołanie:

/rest/subscribers_list/getFields

 

Dane:

  hash Wymagane  Hash listy subskrypcyjnej

 

Zwracane dane:

  hash Hash pola dodatkowego
  name Nazwa pola dodatkowego
  tag Tag pod którym wartości z tego pola będą dostępne w mailach

 

Kody błędów:

  1632

Błędny lub pusty hash listy subskrypcyjnej