Obsolete

Registers a new unsubscribed email.

After registering an email as unsubscribed all future attempts to send a message to this email will be rejected. Please note that there's no way to remove an email from unsubscribed thru the API. But you can send an email with a link to resubscribe using email/subscribe method or remove "unsubscribed" status manually on Email Search page in control panel (but only a limited number of unsubscribed email per day can be removed).

post/unsubscribed/set.json

Request

  • Base URL: https://api.unione.io/en/transactional/api/v1
  • URL: https://api.unione.io/en/transactional/api/v1/unsubscribed/set.json
  • Auth: API key in header X-API-KEY

Request body

addressstring email required

Email to be unsubscribed.

Example request

{
  "address": "email@example.com"
}

Response

Email has been unsubscribed successfully.

status'success' required

"success" string

addressstring email required

The unsubscribed email.

message'unsubscribed' | 'was inactive' | 'was unsubscribed' | 'added and unsubscribed' required

Unsubscription process details: <ul><li>"unsubscribed" if email has just been unsubscribed, <li>"was inactive" if it was inactive due some reason, <li>"was unsubscribed" if it already was unsubscribed before the call, <li>"added and unsubscribed" if it's a new email without status history and it was added and then unsubscribed immediately.</ul>

Changes

No recorded changes to this operation across all 1 revision of this API.