NewsMAN Api - KB NewsMAN

Sectiuni

Newsman – Knowledge Base

HomeAPI

Listare API Newsman

Metoda API	Metoda HTTP	Endpoint	Descriere
List
list.getProps	GET	/list.getProps.json	Returnează un array (cheie / valoare) cu propietățile unei liste
list.updateProps	POST	/list.updateProps.json	Actualizează proprietățile unei liste
list.updateProp	POST	/list.updateProp.json	Actualizează o proprietate a unei liste
list.getProp	GET	/list.getProp.json	Returnează o proprietate a unei liste
list.userlistinfo	GET	/list.all.json	Returnează un array cheie / valoarea cu toate listele
list.all	GET	/list.all.json	Returnează un array cheie / valoarea cu toate listele
list.count	GET	/list.count.json	Returnează numărul de abonați activi dintr-o listă
list.updateName	POST	/list.updateName.json	Actualizează numele unei liste
list.getModerators	GET	/list.getModerators.json	Returnează un array cu moderatorii unei liste
list.setModerators	POST	/list.setModerators.json	Actualizează moderatorii unei liste
list.getIps	GET	/list.getIps.json	Returnează un array cu ip-urile unei liste (un ip per element de array)
list.getSubscribers	GET	/list.getSubscribers.json	Returnează, pentru o listă, abonații cu un anumit status sau inscriși în listă de la un anumit timp (opțional)
list.getSubscriberVariables	GET	/list.getSubscriberVariables.json	Returnează variabilele custom ale unei liste
list.refreshSubscriberVariables	POST	/list.refreshSubscriberVariables.json	Actualizează variabilele custom ale unei liste
list.subscribersHistory	GET	/list.subscribersHistory.json	Returnează un array cu istoricul abonaților unei liste
list.anonymiseSubscriber	POST	/list.anonymiseSubscriber.json	Șterge un abonat dintr-o listă
list.subscribersEvolution	GET	/list.subscribersEvolution.json	Returnează, pentru o listă, evoluția abonaților într-o anumită perioadă (grupată pe zile: nr. total abonați, nr. abonați eligibili, nr. dezabonări, nr. rapoarte spam, nr. hardbounce-uri)
Newsletter
Metoda API	Metoda HTTP	Endpoint	Descriere
newsletter.getProps	GET	/newsletter.getProps.json	Returnează un array (cheie / valoare) cu propietățile unui newsletter
newsletter.getProp	GET	/newsletter.getProp.json	Returnează o proprietate a unui newsletter
newsletter.updateProps	POST	/newsletter.updateProps.json	Actualizează proprietățile unui newsletter
newsletter.updateProp	POST	/newsletter.updateProp.json	Actualizează o proprietate a unui newsletter
newsletter.pause	POST	/newsletter.pause.json	Pune pauză trimiterii unui newsletter
newsletter.resume	POST	/newsletter.resume.json	Repornește un newsletter pus pe pauză
newsletter.schedule	POST	/newsletter.schedule.json	Programează un newsletter să se trimită în viitor
newsletter.cancel	POST	/newsletter.cancel.json	Anulează un newsletter
newsletter.confirm	POST	/newsletter.confirm.json	Confirmă un newsletter prin API
newsletter.sendConfirm	POST	/newsletter.sendConfirm.json	Trimite un mail de confirmare
newsletter.create	POST	/newsletter.create.json	Creează un newsletter în această listă
newsletter.getSegments	GET	/newsletter.getSegments.json	Returnează un array (cheie / valoare) cu segmentele unui newsletter
newsletter.getExcludedSegments	GET	/newsletter.getExcludedSegments.json	Returnează un array (cheie / valoare) cu segmentele excluse unui newsletter
newsletter.setSegments	POST	/newsletter.setSegments.json	Actualizează segmentele unui newsletter
newsletter.setExcludedSegments	POST	/newsletter.setExcludedSegments.json	Actualizează segmentele excluse ale unui newsletter
newsletter.setAlternateContent	GET	/newsletter.setAlternateContent.json	Seteaza conținutul alternativ pentru n newsletter (vizibil online la ##NEWSMAN:view_online##?akey=)
newsletter.all	GET	/newsletter.all.json	Returnează o listă cu newslettere având status $status între $start_date, $stop_date (inclusiv)
newsletter.update	POST	/newsletter.update.json	Actualizează un newsletter în această listă (doar neconfirmat)
newsletter.sendTest	POST	/newsletter.sendTest.json	Trimite un test la mailurile specificate
newsletter.stats	GET	/newsletter.stats.json	Returnează statisticile pentru un newsletter
newsletter.linksClicked	GET	/newsletter.linksClicked.json	Returnează link-urile pe care s-a dat click dintr-un newsletter
newsletter.restart	POST	/newsletter.restart.json	Repornește un newsletter oprit / trimis
newsletter.subscribersHistory	GET	/newsletter.subscribersHistory.json	Returnează un array cu istoricul abonaților unei newsletter
newsletter.statusactions	GET	/newsletter.statusactions.json	Returnează informatii despre status newsletter si actiuni care pot fi intreprinse
Draft
Metoda API	Metoda HTTP	Endpoint	Descriere
draft.getDraftInfo	GET	/draft.getDraftInfo.json	Returnează un array (cheie / valoare) cu informațiile unui draft
draft.getParseDraftHTMLHandlebars	POST	/draft.getParseDraftHTMLHandlebars.json	Parsează codul HTML al unui draft prin Handlebars și returnează codul HTML și parametrii de compilare
Segment
Metoda API	Metoda HTTP	Endpoint	Descriere
segment.all	GET	/segment.all.json	Returnează un array cheie / valoarea cu toate segmentele dintr-o listă
segment.search	GET	/segment.search.json	Returnează un array cheie / valoarea conținând segmentele unei liste care se potrivesc unui regex
segment.count	GET	/segment.count.json	Returnează numărul de abonați activi dintr-un segment
segment.updateName	POST	/segment.updateName.json	Actualizează numele unei segment
segment.delete	POST	/segment.delete.json	Șterge un segment
segment.addSubscriber	POST	/segment.addSubscriber.json	Adaugă un abonat la un segment
segment.removeSubscriber	POST	/segment.removeSubscriber.json	Scoate un abonat dintr-un segment
segment.create	POST	/segment.create.json	Creaază un nou segment într-o listă
segment.clear	POST	/segment.clear.json	Scoate toți abonații dintr-un segment
segment.refresh	POST	/segment.refresh.json	Pornește o actualizare a segmentului
segment.getSubscribers	GET	/segment.getSubscribers.json	Returnează abonații dintr-un segment
segment.massUnsubscribe	POST	/segment.massUnsubscribe.json	Dezabonează toți abonații dintr-un segment
segment.massDeactivate	POST	/segment.massDeactivate.json	Dezactivează toți abonații dintr-un segment
segment.massAnonymise	POST	/segment.massAnonymise.json	Anonimizează toți abonații dintr-un segment
Subscriber
Metoda API	Metoda HTTP	Endpoint	Descriere
subscriber.get	GET	/subscriber.get.json	Returnează informații despre abonat ca array cheie / valoare
subscriber.getByEmail	GET	/subscriber.getByEmail.json	Returnează informații despre abonat ca array cheie / valoare
subscriber.history	GET	/subscriber.history.json	Returnează istoricul acțiunilor unui abonat (ultimele 30 acțiuni) într-un array
subscriber.update	POST	/subscriber.update.json	Actualizează email, firstname, lastname pentru un abonat
subscriber.updateProps	POST	/subscriber.updateProps.json	Actualizează proprietățile unei abonat
subscriber.addTag	POST	/subscriber.addTag.json	Adaugă un tag pe un abonat
subscriber.addTags	POST	/subscriber.addTags.json	Adaugă tag-uri unui abonat
subscriber.removeTag	POST	/subscriber.removeTag.json	Scoate un tag de pe un abonat
subscriber.removeTags	POST	/subscriber.removeTags.json	Actualizează proprietățile unei abonat
subscriber.updatePropsBatch	POST	/subscriber.updatePropsBatch.json	Actualizează proprietățile unui array cu abonați
subscriber.updateProp	POST	/subscriber.updateProp.json	Actualizează o proprietate a unei abonat
subscriber.addToSegment	POST	/subscriber.addToSegment.json	Adaugă un abonat la un segment
subscriber.removeFromSegment	POST	/subscriber.removeFromSegment.json	Scoate un abonat dintr-un segment
subscriber.saveSubscribe	POST	/subscriber.saveSubscribe.json	Salvează / abonează un abonat la o listă
subscriber.initSubscribe	POST	/subscriber.initSubscribe.json	Inițiază o cerere de abonare confirmed opt-in. Este trimis mai întâi un email conținând un link unic pe care trebuie dat click.
subscriber.saveUnsubscribe	POST	/subscriber.saveUnsubscribe.json	Dezabonează un email dintr-o listă
subscriber.saveUnsubscribeById	POST	/subscriber.saveUnsubscribe.json	Dezabonează un abonat dintr-o listă
subscriber.initUnsubscribe	POST	/subscriber.initUnsubscribe.json	Inițiază o cerere de dezabonare. Un email conținând un link pentru dezabonare va fi trimis abonatului
subscriber.getProfilingAllowed	GET	/subscriber.getProfilingAllowed.json	Returnează dacă este permisă profilarea unui abonat
subscriber.setProfilingAllowed	POST	/subscriber.setProfilingAllowed.json	Setează dacă este permisă profilarea unui abonat
subscriber.search	GET	/subscriber.search.json	Returnează abonații dintr-o listă care se potrivesc unor cuvinte cheie, status și data abonării (opțional)
subscriber.anonymiseId	POST	/subscriber.anonymiseId.json	Anonimizează un abonat (după id) dintr-o listă
subscriber.anonymiseEmail	POST	/subscriber.anonymiseEmail.json	Anonimizează un abonat (după email) dintr-o listă
Template
Metoda API	Metoda HTTP	Endpoint	Descriere
template.mailTemplateAdd	POST	/template.mailTemplateAdd.json	Adaugã un template de mailuri tranzacționale pentru această listă. Poate fi folosit ulterior în initSubscribe și initUnsubscribe.
template.mailTemplateDel	POST	/template.mailTemplateDel.json	Șterge un template de mail
template.mailTemplateUpdate	POST	/template.mailTemplateUpdate.json	Actualizează un template de mail tranzacțional pentru această listă
template.mailTemplateGet	GET	/template.mailTemplateGet.json	Returnează conținutul unui template ca array cheie / valoare
template.mailTemplateSearch	GET	/template.mailTemplateSearch.json	Returnează un array cu id-uri de template-uri pentru această listă și acest tip
Download
Metoda API	Metoda HTTP	Endpoint	Descriere
download.subscribed	GET	/download.subscribed.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii abonați a unei liste.
download.unsubscribed	GET	/download.unsubscribed.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii dezabonați (prin link click) a unei liste.
download.unsubscribed_all	GET	/download.unsubscribed_all.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii dezabonați a unei liste, indiferent de metoda dezabonării.
download.bounced	GET	/download.bounced.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii bounced a unei liste.
download.reported_spam	GET	/download.reported_spam.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii care au raportat spam.
download.segment	GET	/download.segment.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la ip-ul curent, conținând utilizatorii unui segment.
download.search	GET	/download.search.json	Returnează un link de download către un fișier CSV conținând utilizatorii care se potrivesc unui criteriu de căutare.
download.newsletterSent	GET	/download.newsletterSent.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care au primit acest newsletter.
download.newsletterViewed	GET	/download.newsletterViewed.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care au vizualizat acest newsletter.
download.newsletterClicked	GET	/download.newsletterClicked.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care au dat click pe acest newsletter.
download.newsletterUnsubscribes	GET	/download.newsletterUnsubscribes.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care s-au dezabonat de la newsletter.
download.newsletterReportedSpam	GET	/download.newsletterReportedSpam.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care au raportat ca spam acest newsletter.
download.newsletterBounced	GET	/download.newsletterBounced.json	Returnează un link de download către un fișier CSV, valid pentru o oră, de la IP-ul curent, conținând utilizatorii care au avut bounce la acest newsletter.
Import
Metoda API	Metoda HTTP	Endpoint	Descriere
import.csv	POST	/import.csv.json	Creează un task care importa useri dintr-un fișier csv (data în $csv_data) în baza de date. Importul va rula în background.
import.schedulecsv	POST	/import.schedulecsv.json	Creează un task care importa useri dintr-un fișier csv (data în $csv_data) în baza de date, după un anumit timp. Importul va rula în background.
import.schedulejsonl	POST	/schedulejsonl.json	Creează task-uri care importă useri (specificați în parametrul json_lines în format JSONL). Un task va fi creat pentru fiecare 20000 useri. Se pot trimite maxim 100000 linii per call. Importurile vor rula în background
import.status	GET	/import.status.json	Returnează status-ul unui import după ID.
Abtest
Metoda API	Metoda HTTP	Endpoint	Descriere
abtest.createVariant	POST	/abtest.createVariant.json	Creează o variantă a unui newsletter (parte din AB Test)
abtest.setTestProps	POST	/abtest.setTestProps.json	Actualizează proprietățile unui AB Test
abtest.getTestProps	GET	/abtest.getTestProps.json	Returnează proprietățile unui AB Test
abtest.getVariantsIds	GET	/abtest.getVariantsIds.json	Returnează un array cu id-urile variantelor
abtest.getVariant	GET	/abtest.getVariant.json	Returnează o anumită variantă a unui AB test
abtest.deleteVariant	POST	/abtest.deleteVariant.json	Șterge o variantă a unui test
abtest.setWinner	POST	/abtest.setWinner.json	Setează câștigătorul unui AB test
Remarketing
Metoda API	Metoda HTTP	Endpoint	Descriere
remarketing.getSettings	GET	/remarketing.getSettings.json	Returnează un array (cheie / valoare) cu propietățile remarketing ale unei liste
remarketing.saveOrder	POST	/remarketing.saveOrder.json	Salveaza o comanda pentru lista care are website-ul asignat
remarketing.clearCart	POST	/remarketing.clearCart.json	Goleste coșul pentru lista care are website-ul asignat si utilizatorul cu adresa email
remarketing.setPurchaseStatus	GET	/remarketing.setPurchaseStatus.json	Salveaza un status nou pentru o comanda, dintr-o lista predefinita de status-uri
Feeds
Metoda API	Metoda HTTP	Endpoint	Descriere
feeds.setFeedOnList	POST	/feeds.setFeedOnList.json	Setează un feed pe o listă
feeds.getFeed	GET	/feeds.getFeed.json	Returnează un array conținand informațiile unui feed dintr-o listă
feeds.getFeeds	GET	/feeds.getFeeds.json	Returnează feed-urile pentru o listă
feeds.updateFeedStatus	POST	/feeds.updateFeedStatus.json	Actualizează status-ul unui feed dintr-o listă
feeds.initFeedRefresh	POST	/feeds.initFeedRefresh.json	Pornește un proces de refresh pentru un feed dintr-o listă
feeds.updateFeed	POST	/feeds.updateFeed.json	Actualizează proprietățile unui feed
feeds.deleteFeed	POST	/feeds.deleteFeed.json	Șterge un feed dintr-o listă
feeds.getFeedProducts	GET	/feeds.getFeedProducts.json	Returnează produsele unui feed (maxim 5000 deodată)
feeds.addFeedProducts	POST	/feeds.addFeedProducts.json	Adaugă produse într-un feed de tip fixed
feeds.removeFeedProducts	POST	/feeds.removeFeedProducts.json	Scoate produse dintr-un feed de tip fixed
feeds.replaceFeedProducts	POST	/feeds.replaceFeedProducts.json	Înlocuiește produsele dintr-un feed de tip fixed
feeds.addProductGroupToList	POST	/feeds.addProductGroupToList.json	Adaugă un grup de produse într-o listă
feeds.getProductGroup	GET	/feeds.getProductGroup.json	Returnează un array conținand informațiile unui grup de produse dintr-o listă
feeds.getProductGroups	GET	/feeds.getProductGroups.json	Returnează grupurile de produse pentru o listă
feeds.getProductGroupProducts	GET	/feeds.getProductGroupProducts.json	Returnează produsele unui grup de produse (un grup de produse poate conține maxim 100 de produse)
feeds.updateProductGroup	POST	/feeds.updateProductGroup.json	Actualizează proprietățile unui grup de produse
feeds.updateProductGroupStatus	POST	/feeds.updateProductGroupStatus.json	Actualizează status-ul unui grup de produse dintr-o listă
feeds.initProductGroupRefresh	POST	/feeds.initProductGroupRefresh.json	Pornește un proces de refresh pentru un grup de produse dintr-o listă
feeds.deleteProductGroup	POST	/feeds.deleteProductGroup.json	Șterge un grup de produse dintr-o listă
Coupons
Metoda API	Metoda HTTP	Endpoint	Descriere
coupons.getCoupons	GET	/coupons.getCoupons.json	Returnează cupoanele pentru o listă
coupons.getCoupon	GET	/coupon.getCoupon.json	Returnează un array conținand informațiile unui cupon dintr-o listă
coupons.getByName	GET	/coupon.getByName.json	Returnează un array conținand informațiile unui cupon, după nume, dintr-o listă
coupons.addCoupon	POST	/coupon.addCoupon.json	Returnează un array conținand informațiile cuponului adăugat
coupons.updateCoupon	POST	/coupon.updateCoupon.json	Returnează un array conținand informațiile cuponului actualizat
coupons.getCouponCodes	GET	/coupons.getCouponCodes.json	Returnează un Array având codurile cuponului. Fiecare element este un array cheie / valoare având cheile: code, created_at, expires_at, sent, subscriber_id, email, newsletter_id, form_id
coupons.importCouponCodes	POST	/coupons.importCouponCodes.json	Programează importul de coduri pentru un cupon
coupons.generateCouponCodes	POST	/coupons.generateCouponCodes.json	Programează generarea de coduri pentru un cupon
coupons.clearCouponCodes	POST	/coupons.clearCouponCodes.json	Programează golirea de coduri pentru un cupon
coupons.deleteCoupon	POST	/coupons.deleteCoupon.json	Programează ștergerea unui cupon
Webhook
Metoda API	Metoda HTTP	Endpoint	Descriere
webhook.getListWebhook	GET	/webhook.getListWebhook.json	Returnează un array (cheie / valoare) cu setările webhook unei liste
webhook.setListWebhook	POST	/webhook.setListWebhook.json	Activează setări webhook pe o listă
webhook.removeListWebhook	POST	/webhook.removeListWebhook.json	Dezactivează setările webhook de pe o listă
Sms
Metoda API	Metoda HTTP	Endpoint	Descriere
sms.getCurrentCreditsNumber	GET	/sms.getCurrentCreditsNumber.json	Returnează numărul de credite SMS disponibile curent
sms.lists	GET	/sms.lists.json	Returnează un array cheie / valoarea cu toate listele SMS
sms.sendone	POST	/sms.sendone.json	Trimite un mesaj SMS către un destinatar
sms.getByTelephone	GET	/subscriber.getByTelephone.json	Returnează informații despre abonat ca array cheie / valoare
sms.saveSubscribe	POST	/sms.saveSubscribe.json	Salvează / abonează un abonat la o listă
sms.saveUnsubscribe	POST	/subscriber.saveUnsubscribe.json	Dezabonează un telefon dintr-o listă
sms.getCampaignProps	GET	/sms.getCampaignProps.json	Returnează un array (cheie / valoare) cu propietățile unei campanii
sms.getCampaignProp	GET	/sms.getCampaignProp.json	Returnează o proprietate a unui campanii
sms.updateCampaignProps	POST	/sms.updateCampaignProps.json	Actualizează proprietățile unui campanii
sms.updateCampaignProp	POST	/sms.updateCampaignProp.json	Actualizează o proprietate a unei campanii
sms.pauseCampaign	POST	/sms.pauseCampaign.json	Pune pauză trimiterii unui campanii
sms.resumeCampaign	POST	/sms.resumeCampaign.json	Repornește o campanie pusă pe pauză
sms.scheduleCampaign	POST	/sms.scheduleCampaign.json	Programează o campanie să se trimită în viitor
sms.cancelCampaign	POST	/sms.cancelCampaign.json	Anulează o campanie
sms.confirmCampaign	POST	/sms.confirmCampaign.json	Confirmă o campanie prin API
sms.sendCampaignConfirm	POST	/sms.sendCampaignConfirm.json	Trimite un mail de confirmare
sms.createCampaign	POST	/sms.createCampaign.json	Creează o campanie în această listă
sms.getCampaignSegments	GET	/sms.getCampaignSegments.json	Returnează un array (cheie / valoare) cu segmentele unei campanii
sms.getCampaignExcludedSegments	GET	/sms.getCampaignExcludedSegments.json	Returnează un array (cheie / valoare) cu segmentele excluse ale unei campanii
sms.setCampaignSegments	POST	/sms.setCampaignSegments.json	Actualizează segmentele unei campanii
sms.setExcludedCampaignSegments	POST	/sms.setExcludedCampaignSegments.json	Actualizează segmentele excluse ale unei campanii
sms.allCampaigns	GET	/sms.allCampaigns.json	Returnează o listă cu campanii având status $status între $start_date, $stop_date (inclusiv)
sms.campaignStats	GET	/sms.campaignStats.json	Returnează statisticile pentru o campanie
sms.campaignLinksClicked	GET	/sms.campaignLinksClicked.json	Returnează link-urile pe care s-a dat click dintr-o campanie
sms.restartCampaign	POST	/sms.restartCampaign.json	Repornește o campanie oprită / trimisă
sms.campaignSubscribersHistory	GET	/campaign.subscribersHistory.json	Returnează un array cu istoricul abonaților unei campanii
sms.campaignStatusActions	GET	/sms.campaignStatusActions.json	Returnează informatii despre status campanie si actiuni care pot fi intreprinse
Automation
Metoda API	Metoda HTTP	Endpoint	Descriere
automation.all	GET	/automation.all.json	Returnează o listă cu automatizări având nume $name, tip $type, status $status actualizate între $start_date, $stop_date (inclusiv)
automation.setWorkflowStatus	POST	/automation.setWorkflowStatus.json	Actualizează status-ul unei automatizări
automation.getWorkflow	GET	/automation.getWorkflow.json	Returnează informațiile pentru o automatizare