Newsletter API v1 and v2
Antivirus scan
Powered by ClamAV
✅ Verified clean
This product file has passed our security filters.
Want to run a fresh ClamAV scan right now? Takes a few seconds and shows scanner version, signature DB and live result.
This can take 5 to 30 seconds.
Clean file Threat detected
No threats detected in this file.
- File
- Size
- Scanned
- ClamAV
- Signature database
⚡ Powered by ClamAV
Scan could not be completed
Report product
If you detected an issue (broken file, malware, inappropriate content, etc.) let us know and we'll review it ASAP.
Sign in to report
About Newsletter API v1 and v2
If your CRM or app needs to talk to your subscriber list
Subscribers rarely start out only in WordPress: they arrive from a CRM, an app or an external form, and copying them by hand ends in out-of-date lists. The serious problem is not the extra work but that an unsubscribe recorded in another system never reaches the blog and you keep emailing someone who no longer wants to hear from you. Newsletter API v1 and v2 is the add-on that opens the REST API of the Newsletter plugin so those systems can sync data on their own.
It suits you if you have someone who can program server-to-server integrations. It does not suit you if you want forms, email design or a new screen in the dashboard: this is only the connection layer. Also:
- Most calls require an authentication key, which must stay on the server and never in a public client.
- There is no way for a subscriber to edit their profile from an external app or site by calling the API directly; you would have to build that service on your server.
- Nor can you start an unsubscription through the public API: subscribers use the unsubscribe link in each newsletter.
Adding, updating and deleting subscribers from another system
The subscribers endpoint covers the full cycle with three methods:
- POST adds a new subscriber. It only requires the email, accepts private lists and private profile fields, and returns the subscriber with their ID. If they already exist, it returns an error and does not change them. It sends no activation or welcome emails, and it assumes you already have consent.
- PUT updates by ID or by email, and also works to create or update in a single call. It only changes the fields you send, so you can touch a single data point. It even lets you change the email, as long as the new one does not belong to another subscriber.
- DELETE removes the subscriber.
To add or remove someone from a list, use PUT with the list set to 1 (add) or 0 (remove). If that list is connected to a series in the Autoresponder addon, the subscriber starts receiving it, but the link is processed within up to 5 minutes: a first step with zero delay does not go out instantly.
Unsubscribing and deleting are different things in Newsletter API v1 and v2
Changing the status to unsubscribed (or bounced) keeps all of the subscriber's data and only blocks sending. It is a PUT with the ID or email and the new status, and it does not fire events such as sending emails. If the email does not exist, a subscriber is created with that status.
Deletion with DELETE is total and irreversible: personal data disappears, and so do the statistics on their interaction with your mailings. Use it for data erasure requests, not for ordinary unsubscriptions.
If you give no status when creating, the subscriber is set as confirmed and can receive newsletters. If your CRM has contacts without clear consent, send the right status in the call.
Subscriptions from an app using the standard process
The subscriptions endpoint (POST) can be called from public clients and needs no key. With just the email it starts the whole process: spam check, duplicate detection and an activation or welcome email depending on the configured opt-in. There are options to override the defaults from the dashboard. It is the route for an app that should behave like a normal form.
Other useful endpoints:
- Lists: with GET and a key it returns all of them, public and private.
- Newsletters: by default it returns the last 10 fully sent, with pagination, ideal for an archive. Without a key only public ones appear; drafts, scheduled and in-progress newsletters do not show up.
- Action newsletter_api_user_saved: it fires when a subscriber is created or updated through the API and receives the new one, the previous one (null on creation) and the request, so you can run your own code.
Frequently asked questions about Newsletter API v1 and v2
- Should I use v1 or v2? Both work, but v2 is more complete and flexible; if you are starting a new integration, begin with it.
- Does it work without the Newsletter plugin? No, it is an add-on that exposes that plugin's functions.
- Can I test it locally without HTTPS? Yes, by defining NEWSLETTER_REST_ALLOW_NON_HTTPS_REQUEST as true in wp-config.php. Keys will travel unencrypted, so do not leave it that way in production.
- Can I call the subscribers endpoint from the browser? No: it requires a key that must be kept private.
- Does it run an anti-spam check when adding subscribers? Not with the subscribers POST, which only does simple data cleanup and mostly fails on invalid emails. For spam control use the subscriptions endpoint.
Topics
Version history
-
v
2.5.8 Current 5 Sep 2026
-
v
2.5.7 30 May 2026
-
v
2.5.5 16 Apr 2026
Customer reviews
Sign in to leave a review. Only people who have the product can review it.
No reviews for this product yet.
Frequently asked questions
-
GPL (General Public License) is the license under which WordPress and most premium plugins/themes are distributed. It grants you the right to use, modify and redistribute the software in as many projects as you want, with no domain restrictions.
-
Yes. With membership you get automatic updates via our GPLClub Updater plugin (installed on your WP, detects new versions and applies them). With individual purchase, you get one year of manual updates from your account.
-
Depends on the plan. Monthly: 3 domains. Semi-annual: 7. Annual and Lifetime: 15. Individual purchase: 1 domain.
-
GPLClub offers its own support for installation, configuration and compatibility. For direct support from the original author (feature requests, product-specific bugs), a license purchased from the author is required.
