Foldery dla modułu poczty. Endpoint odpowiedzialny za zarządanie ustawieniami folderów w module poczty.

Endpointy obsługujące żądanie:

  • https://api.5ways.com - Ekspert

Uprawnienia:

  • Admin, Ekspert, specjalista, praktykant - GET, POST

Pola zasobu

Klucz Typ danych Opis
id integer Unikalny identyfikator ustawień folderu
customer_id integer Identyfikator instancji
user_id integer Identyfikator użytkownika
order string Kolejność folderów
created string Data utworzenia ustawień (format ISO 8601)
modified string Data ostatniej modyfikacji (format ISO 8601)

Pobieranie folderów

GET /rest/mail_folder_setting

Zwraca ustawienia folderów modułu pocztowego. Zwracane ustawienia są izolowane do aktywnej sesji użytkownika.

Zwracane dane
// HTTP/1.1 200 OK
{
  "MailFolderSetting": {
    "id": "1",
    "customer_id": "1",
    "user_id": "1",
    "order": "",
    "created": "2025-09-02T10:22:58+00:00",
    "modified": "2025-09-02T10:22:58+00:00"
  }
}

Aktualizacja ustawień folderów

POST /rest/mail_folder_setting

Aktualizacja/inicjalizacja ustawień folderów.

Ze względu na to, że ustawienia folderów są przechowywane w pojedynczym wpisie, możliwa jest tylko aktualizacja lub inicjalizacja ustawień folderów. Wysłanie żądania POST powoduje, że API automatycznie izoluje ustawienia do aktywnej sesji użytkownika (bez podawania identyfikatora w adresie endpointu).

Pole order przyjmuje wartość w postaci tablicy JSON, np. [1,2,3], gdzie elementy to identyfikatory folderów. Kolejność elementów w tablicy odpowiada kolejności sortowania folderów (patrz endpoint mail_folder).

{
  "MailFolderSetting": {
    "order": "[1,2,3]",
  }
}
Odpowiedź

Zwraca dane zmodyfikowanych ustawień.

HTTP/1.1 200 OK
{
    "id": "1",
    "customer_id": "1",
    "user_id": "1",
    "order": "",
    "created": "2025-09-02T10:22:58+00:00",
    "modified": "2025-09-02T10:22:58+00:00"
}