• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
The Newsletter Plugin Documentation

The Newsletter Plugin Documentation

Every little detail discovered.

  • Premium
  • Support Ticket
  • Account
  • Blog

Newsletter Legacy API

Newsletter core contains a set of API for coders which can be exposed as REST API with the free Newsletter REST API extension. 

The legacy API are deprecated and they’re not part of the Newsletter plugin. To use them you need to install the free Newsletter API Addon and change the endpoints in this way. You can find the addon inside the “Addons” page in your Newsletter installation.

From: http://www.yourdomain.com/wp-content/plugins/newsletter/api/add.php
To: http://www.yourdomain.com/wp-content/plugins/newsletter-api/add.php

We strongly suggest to use the new REST API.

The API key

The API key is a secret sequence of characters that must be passed on while calling the externally exposed API of the Newsletter plugin. If that field is left empty, the API are disabled. The API are implemented with the code located in the “api” sub-folder if you need to look at it.

The API key must be passed on each HTTP call using the parameter named “nk”.

The API key can be set on main configuration panel.

Legacy calls

Add a Subscriber

To add a subscriber call with a POST (actually even the GET works…)

http://www.yourdomain.com/wp-content/plugins/newsletter-api/add.php

A subscriber is always added in confirmed status.

Parameters

nk is the API key (required)
ne is the email address (required)
nn is the first name
ns is the last name
nl is a | separated list of lists numbers

Example 1

http://www.yourdomain.com/wp-content/plugins/newsletter-api/add.php?nk=yoursecretkey
&ne=stefano@thenewsletterplugin.com
&nn=Stefano
&ns=Lissa
&nl=1|3

Delete a Subscriber

Subscribers are delete by email address with the call:

http://www.yourdomain.com/wp-content/plugins/newsletter-api/delete.php?nk=yoursecretkey

Parameters

ne is the email address (required)

Have you ever considered going premium?

With a premium plan, you'll get whole collection of 30+ professional addons, along with a full year of updates and priority support. No automatic renewals, frequent releases and a solid 30 days refund policy.

Go Premium Now!

Primary Sidebar

  • Installation
  • Getting Started
  • How to Install Addons
  • How to install the Addons Manager
  • Main Configuration
  • The Status Panel
  • Subscription
  • Subscription Basics
  • Lists
  • Spam Subscriptions
  • Subscription forms and shortcodes
  • Custom coded forms
  • GDPR compliancy
  • Subscribers and management
  • Profile page
  • Cancellation
  • Subscribers Statistics
  • Subscribers Management
  • Newsletters
  • Create and Send Newsletters
  • The Newsletter Composer
  • Targeting
  • Extra Profile Fields and Profile Fields Targeting
  • Tags
  • Multilanguage
  • Addons
  • Delivery Addons
  • Amazon SES Addon
  • SendGrid Addon
  • Sendinblue Addon
  • SparkPost Addon
  • ElasticEmail Addon
  • Mailgun Addon
  • MailJet Addon
  • Extended Features
  • Advanced Import
  • Automated
  • Autoresponder
  • Bounce Management
  • Geolocation Extension
  • Google Analytics Extension
  • Leads Extension
  • Locked Content
  • Reports and Retargeting
  • Archive
  • Speed Control
  • Subscribe on Comment
  • WP User Registration
  • Integrations
  • BuddyPress Integration
  • Contact Form 7 Integration
  • Event Manager Integration
  • Facebook Integration
  • Ninja Forms Integration
  • The Events Calendar Integration
  • Translatepress Integration
  • WooCommerce Integration
  • WP Forms Integration
  • Instasend
  • Customization
  • Forms style
  • Message templates
  • Delivery and spam
  • Delivery Speed And The Cron Problem
  • Email Delivery Issues
  • The Spam Problem
  • Developers & Advanced Topics
  • Backup, Recovery, Delete
  • Composer Blocks
  • Constants
  • Filters and Actions
  • Incompatibilities
  • Newsletter API Version 2
  • Newsletter API version 1
  • Newsletter Legacy API