Returns a page of unsubscriptions.

Attributes

Parameter Default Description
from_date   If provided, only the unsubscriptions after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00
to_date   If provided, only the unsubscriptions before (excluding) the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
mailing_id   Multivalued parameter to filter the unsubscriptions by mailings. Each value must correspond to a mailing id.
ids Multivalued parameter to filter the results by contacts. Each value must correspond to a contact id.
emails Multivalued parameter to filter the results by email addresses.
eids Multivalued parameter to filter the results by external ids. Each value must correspond to a contacts external id
source   Filters the unsubscriptions by their source. The source can be an unsubscription link (link), a reply mail (reply) or other.
embed_field_backups false Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
page_index  1 The index of the result page. The index must be greater or equal to 1.
page_size 100 The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Reply

Parameter Optional Description
contact false The available contact details, only the Maileon ID, the external ID and the Email-Address are available
timestamp false The timestamp of the unsubscription as yyyy-mm-dd hh:mm:ss
mailing_id true The ID of the mailing the unsubscription came from.
source false The source of the unsubscription. The following values are valid:

  • reply (the contact replied manually and wrote that he does not want to be subscribed any more)
  • link (the contact used the „unsubscription link“ inside the email)
  • list-unsubscribe-header (the contact used a feature of its mail client that supports the list-unsubscribe feature, see http://www.list-unsubscribe.com/ )
  • complaint (when a contact registers a complaint, he will be unsubscribed automatically)
  • import (the contact was unsubscribed using the „import unsubscriber“ funktion (e.g. over FTP)
  • contactsjob (contacts can also be unsubscribed on a regular base by a contact job, e.g. using some contact filter as selection criteria)
  • api (the unsubscription was triggered via the REST API)
  • manual (contact has been unsubscribed using the Maileon UI)
  • wa-action (if the user has been unsubscribed by a marketing automation program)
  • other (in unknown cases)

 

Example