nuevoMailer API

You will find the related files and examples in the folders apiv1 and apiv2 of your package.

Subscribers

HTTP method Endpoint Function Response type Comments
GET /apiv2/subscribers Get all subscribers Html (tabular) or Json depending on the accept headers sent.
GET /apiv2/subscribers/email@domain.com Get one subscriber Html (tabular) or Json depending on the accept headers sent.
GET /apiv2/subscribers/email@domain.com/lists Get one subscriber's lists Html (tabular) or Json depending on the accept headers sent.
GET /apiv2/subscribers/email@domain.com?list=ID Is the subscriber in this list? false: not in list.
0: yes but unverified
-1: yes and verified.
GET /apiv2/subscribers?list=ID All subscribers (emails) under a list. Html (tabular) or Json depending on the accept headers sent.
DELETE /apiv2/subscribers/email@domain.com Delete a subscriber ok
POST /apiv2/subscribers/ Add new.
Remove globally or from list(s).
Create a transactional email.
Update existing.
With or w/o double opt-in.
With or w/o sending greeting emails.
Json posted data.
The post is rerouted to optIn.php.
For a complete list of arguments and features see here.
PUT /apiv2/subscribers/ Add a subscriber to the suppression list. ok Json posted data.

Mailing lists

HTTP method Endpoint Function Response type Comments
GET /apiv2/lists Get all lists including subscribers in total. Html (tabular) or Json depending on the accept headers sent.
GET /apiv2/lists/ID Get one list including subscribers in total. Html (tabular) or Json depending on the accept headers sent.
DELETE /apiv2/lists/ID Delete a list ok
POST /apiv2/lists/ Add a new list. Will return data about the newly created list in Html (tabular) or Json depending on the accept headers sent. Json posted data.
PUT /apiv2/lists/ Update a list. Will return data about the updated list in Html (tabular) or Json depending on the accept headers sent. Json posted data.

Newsletters

HTTP method Endpoint Function Response type Comments
GET /apiv2/newsletters A list of titles of public newsletters. Html with a link to the newsletter page or Json depending on the accept headers sent.
GET /apiv2/newsletters/menu Creates a drop-down menu of titles: on selection it loads the newsletter underneath in an iframe. Html
GET /apiv2/newsletters/ID Display a newsletter in an iframe. Html
POST /apiv2/newsletters/ Create/add a newsletter. Will return the ID of the newly created newsletter. Json posted data: body, subject as strings, properly escaped. See example file.
PUT /apiv2/newsletters/ Update an existing newsletter. Will return the ID of the updated newsletter. Json posted data: ID, body, subject as strings, properly escaped. See example file.
DELETE /apiv2/newsletters/ID Delete a newsletter. ok

Campaigns

HTTP method Endpoint Function Response type Comments
GET /apiv2/campaigns/ID/stats Get campaign key statistics like in summary report. Html (tabular) or Json depending on the accept headers sent.
GET /apiv2/campaigns/ID Get campaign info. Html (tabular) or Json depending on the accept headers sent.
POST /apiv2/campaigns/ Create a new campaign. Will return campaign info in Html (tabular) or Json depending on the accept headers sent. Json posted data.
DELETE /apiv2/campaigns/ID Delete a campaign. ok
PUT /apiv2/campaigns/ Update details (content, lists etc), pause or resume a campaign. Will return campaign info in Html (tabular) or Json depending on the accept headers sent. Json posted data.
 
 
© 2019 Designerfreesolutions
Visit nuevoMailer.com
Visit the Demo