PHPackages                             magedin/module-newsletter-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. magedin/module-newsletter-api

ActiveMagento2-module[API Development](/categories/api)

magedin/module-newsletter-api
=============================

The MagedIn\_NewsletterApi module extends Magento 2's capabilities by providing a comprehensive API for managing newsletter subscriptions. This module allows developers to easily integrate and manage newsletter functionalities through a robust and secure API.

1.0.0(1y ago)01OSL-3.0PHPPHP ^7.4||^8.0

Since Jul 11Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/magedin/magento2-module-newsletter-api)[ Packagist](https://packagist.org/packages/magedin/module-newsletter-api)[ RSS](/packages/magedin-module-newsletter-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Newsletter API for Magento 2 by MagedIn Technology
==================================================

[](#newsletter-api-for-magento-2-by-magedin-technology)

Overview
--------

[](#overview)

The `MagedIn_NewsletterApi` module extends Magento 2's capabilities by providing a comprehensive API for managing newsletter subscriptions. This module allows developers to easily integrate and manage newsletter functionalities through a robust and secure API.

Features
--------

[](#features)

- Subscribe and unsubscribe users to newsletters
- Retrieve subscriber information
- Manage subscription statuses
- Secure and easy-to-use endpoints

Installation
------------

[](#installation)

### Prerequisites

[](#prerequisites)

- Magento 2.3.x, 2.4.x
- Composer

Usage of New API Endpoints
--------------------------

[](#usage-of-new-api-endpoints)

### Using Customer Token

[](#using-customer-token)

- **Get Self Subscription Status**

    - **Endpoint**: GET `/V1/newsletter/subscription/mine`
- **Subscribe Self**

    - **Endpoint**: POST `/V1/newsletter/subscription/mine`
- **Unsubscribe Self**

    - **Endpoint**: DELETE `/V1/newsletter/subscription/mine`

### No Token Needed

[](#no-token-needed)

- **Guest-Subscribe by Email**

    - **Endpoint**: POST `/V1/newsletter/guest-subscription`
    - **Payload**: ```
        {
          "email": "Kenna.McClure85@hotmail.com",
          "store_id": 1
        }
        ```
- **Guest Unsubscribe by Email**

    - **Endpoint**: POST `/V1/newsletter/guest-subscription/delete`
    - **Payload**: ```
        {
          "email": "Kenna.McClure85@hotmail.com",
          "store_id": 1
        }
        ```

### Using Admin Token

[](#using-admin-token)

- **Get Subscription Status**

    - **Endpoint**: GET `/V1/newsletter/subscription/:customer_id`
- **Subscribe**

    - **Endpoint**: POST `/V1/newsletter/subscription`
    - **Payload**: ```
        {
          "customer_id": 1,
          "store_id": 1
        }
        ```
- **Unsubscribe**

    - **Endpoint**: POST `/V1/newsletter/subscription/delete`
    - **Payload**: ```
        {
          "customer_id": 1,
          "store_id": 1
        }
        ```

Support
-------

[](#support)

For any issues or questions, please contact our support team:

- Email:

Contributing
------------

[](#contributing)

We welcome contributions to improve this module. Please submit your pull requests to the develop branch.

Acknowledgments
---------------

[](#acknowledgments)

Thank you for using Newsletter API for Magento 2 by MagedIn Technology. Your feedback and support are greatly appreciated.

###  Health Score

32

—

LowBetter than 71% of packages

Maintenance66

Regular maintenance activity

Popularity1

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

666d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8e44bd4b4b077a04791cb2298a5faa8f376db4b51977b3750d5348670a0b3457?d=identicon)[tiagosampaio](/maintainers/tiagosampaio)

---

Top Contributors

[![tiagosampaio](https://avatars.githubusercontent.com/u/1485260?v=4)](https://github.com/tiagosampaio "tiagosampaio (11 commits)")[![rrojin-mcfadyen](https://avatars.githubusercontent.com/u/75588464?v=4)](https://github.com/rrojin-mcfadyen "rrojin-mcfadyen (4 commits)")[![cgouli](https://avatars.githubusercontent.com/u/41359829?v=4)](https://github.com/cgouli "cgouli (1 commits)")

### Embed Badge

![Health badge](/badges/magedin-module-newsletter-api/health.svg)

```
[![Health](https://phpackages.com/badges/magedin-module-newsletter-api/health.svg)](https://phpackages.com/packages/magedin-module-newsletter-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M186](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M33](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M452](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)