Newsletter – API v1 and v2 2.3.5
The Newsletter API Version 2 allows you to seamlessly integrate external systems with the Newsletter plugin using our REST API. With this API, you can easily manage subscribers, update their data, set their status, and perform various other operations.
Key Features:
- Add subscribers to your blog when they are added to your CRM or similar tool
- Update existing subscribers with new data collected elsewhere
- Add or update subscribers in a single call
- Set subscribers as bounced or unsubscribed
- Add subscribers to specific lists
- Delete subscribers completely
- Start the standard subscription or cancellation process
- Allow subscribers to change their profile data via a public service
- Get the configured subscription lists
- Retrieve a list of the last newsletters sent
- Test the API on localhost without HTTPS
To add subscribers, use the subscribers endpoint with the POST method. You need to provide a JSON object in the request body, with the email address being the only required field. You can also set private lists and profile fields.
Note that this method requires authentication and should only be used for server-to-server data exchange. It does simple data cleanup and assumes the data provided by your other system is already correct.
The endpoint returns an error if the subscriber is already present without changing it. Therefore, it can only be used to add new subscribers. No activation or welcome emails are sent; instead, the subscriber is inserted into the database, and their data, including the assigned ID, is returned.
To update subscriber data, use the subscribers endpoint with the PUT method. This endpoint allows you to overwrite the current data stored in the blog with any kind of subscriber field. Any fields not provided in the request will retain their original value. This makes it easy to make specific changes to subscriber data, including private lists and profile fields.
Benefits of Newsletter – API v1 and v2 2.3.5:
- Easily integrate external systems with the Newsletter plugin
- Effortlessly manage subscribers and their data
- Seamlessly add or update subscribers in a single call
- Flexible options for setting subscriber status
- Ability to work with private lists and profile fields
- Retrieve lists of the last newsletters sent
- Efficiently test the API on localhost without HTTPS
- Active development and support from the team at EffectIO
Update your plugins through the EffectIO Dashboard and enjoy the benefits of our cost-saving update channel. All items are pre-activated and come with a GPL code license for maximum flexibility. Plus, you’ll receive premium support from our experts.
