Newsman – Knowledge Base
Metoda API Newsman: list.getProps
Prototip: list.getProps(list_id)
Descriere: Returnează un array (cheie / valoare) cu propietățile unei liste
Metoda HTTP: GET
Endpoint HTTP: /list.getProps.json
Endpoint XML-RPC: list.getProps
Tip raspuns: struct
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | int|string | ID-ul listei pentru care se dorește preluarea proprietăților |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| after_unsubscribe_goto | Link-ul custom pentru dezabonare al listei (dacă există) |
| from_email | Adresa de from |
| from_name | Numele de from |
| link_params_append | Parametrii adăugați la link click |
| list_secret | Secretul listei (ex: a se folosi pentru verificare hash la abonat) |
| owner | Numele proprietarului listei |
| owner_adresa | Adresa proprietarului listei |
| owner_email | Emailul proprietarului listei |
| owner_telefon | Telefonul proprietarului listei |
| owner_url | Url-ul proprietarului listei |
| send_rate_text | Mesajul de frecvență al listei (poate fi afișat în formulare) |
| site_name | Numele site-ului la care lista face referire |
| site_url | URL-ul site-ului la care lista face referire |
Exemple request
Exemplu output
{ "from_email": "info@example.com", "from_name": "Example.com", "link_params_append": "utm_source=newsletter&utm_campaign=##subject##&utm_content=Newsletter-##newsletter_id##-##date##&utm_medium=email", "list_secret": "my secret here", "owner": "Owner Name", "owner_adresa": "Example Street", "owner_email": "info@example.com", "owner_telefon": "Owner Telephone", "owner_url": "https:\/\/www.example.com", "send_rate_text": "weekly", "site_name": "Example", "site_url": "https:\/\/www.example.com" }
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param list_id | Parametrul list_id este obligatoriu |
| 101 | Not allowed for list_id = %s | Acces nepermis la list_id |
Exemple de erori
{ "err": true, "message": "Missing required param list_id", "code": 407 }