How does the unsubscribe API work?

You can post unsubscribes over to MageMail by using the REST API. You can find your MageMail API key in the Magento module settings under Promotions > MageMail > Advanced.

Here is an example. You can actually run this yourself to test it - this is a valid API key for the MageMail demo account.

The response you can expect is:

If you receive an error, the `success` value will be `false`.

A few expected error cases are:

- Invalid email format - Email address is already unsubscribed - Invalid API key

Still need help? Contact Us Contact Us