Newsletter - API v1 and v2

This API guide helps developers integrate external systems with the Newsletter plugin using REST API Version 2. It covers common use cases like adding subscribers from a CRM, updating profile data, and managing subscription lists. The API requires an authentication key for server-to-server calls and supports both POST and PUT methods on the /subscribers endpoint.

• Add new subscribers: Use the POST method on /subscribers with a JSON body containing the email address. The endpoint returns an error if the subscriber already exists. It does not send activation or welcome emails.
• Update existing subscribers: Use the PUT method to overwrite subscriber data by matching on email address or subscriber ID. Fields not provided remain unchanged.
• Change subscriber status: Set a subscriber to bounced, unsubscribed, or confirmed by providing the new status with the PUT method. This does not trigger events like email sending.
• Manage lists: Add or remove subscribers from specific lists by setting list values to 1 or 0 in the request body.
• Delete subscribers: Use the DELETE method to permanently remove all subscriber data, including statistics. For unsubscription without data loss, change the status instead.

The API also includes actions like newsletter_api_user_saved for custom processing after subscriber creation or update. Both API Version 1 and Version 2 are supported via a free addon.