MRepl REST API Documentation

Authentication

Requests must be authenticated using a valid API token found in the database. Provide your token in the request header using one of the following methods:

X-API-Key: YOUR_API_TOKEN

Or via Bearer authentication:

Authorization: Bearer YOUR_API_TOKEN

The API automatically identifies your user profile and restricts access only to the mailing lists you own.

Endpoints

GET /status

Retrieve the current status of an email address on the mailing list.

Parameter	Type	Description
email	Required	The email address to query.
list_id	Optional	Mailing list ID. Required only if your API token owns multiple lists.

Response example (Email found and active):

{
  "status": "success",
  "code": 200,
  "data": {
    "status": "subscribed",
    "message": "Active subscriber."
  }
}

POST /subscribe

Add a new subscriber to your mailing list. If the user was previously unsubscribed, you must supply force=1 to re-subscribe them.

Parameter	Type	Description
email	Required	The email address to subscribe.
list_id	Optional	Target mailing list ID.
name	Optional	Full name (saved as field mapping).
list_name	Optional	Sub-list identification (saved as list mapping).
force	Optional	Send `1` to force re-enabling a previously unsubscribed user.

Response example:

{
  "status": "success",
  "code": 201,
  "data": {
    "status": "subscribed",
    "message": "Successfully subscribed."
  }
}

POST /unsubscribe

Mark an email address as unsubscribed (status code set to 1) and record the event in the system logs.

Parameter	Type	Description
email	Required	The email address to unsubscribe.
list_id	Optional	Target mailing list ID.

POST /block

Blacklist/block an email address (status set to 2) to permanently prevent outgoing deliveries to this address.

Parameter	Type	Description
email	Required	The email address to blacklist.
list_id	Optional	Target mailing list ID.