-
-
-
- Bald verfügbar
-
- Bald verfügbar
-
-
-
-
-
- Bald verfügbar
-
- Adding Unsubscription Reason
- Contacts
- Count Active Contacts By Filter ID
- Count Contacts By Filter ID
- Create Contact
- Create Contact (JSON)
- Create Contact by External ID
- Create Contact by External ID (JSON)
- Create Custom Field
- Custom Contact Fields
- Delete All Contacts
- Delete Contact By Maileon ID
- Delete Contacts By Email
- Delete Contacts By External ID
- Delete Custom Field
- Delete Custom Field Values
- Delete Standard Field Values
- Get Blocked Contacts
- Get Contact By Email
- Get Contact By Maileon ID
- Get Contacts
- Get Contacts By Email
- Get Contacts By External Id
- Get Contacts By Filter Id
- Get Count Contacts
- Get Custom Fields
- Rename Custom Field
- Standard Contact Fields
- Synchronize Contacts
- Synchronize Contacts Error Codes
- Unsubscribe Contact By Maileon Id
- Unsubscribe Contacts By Email
- Unsubscribe Contacts by External Id
- Update Contact By Email
- Update Contact By External ID
- Update Contact By Maileon ID
- Alle Artikel anzeigen ( 21 ) Artikel zusammenklappen
-
- Copy Mailing
- Create Dispatching
- Create Mailing
- Delete Mailing
- Delete Trigger
- Get Dispatching
- Get limit on number of contacts
- Get Mailing Archive URL
- Get Mailing ID By Name
- Get Mailing Report URL
- Get Mailings By Creator Name
- Get Mailings By Keywords
- Get Mailings By Schedule Time
- Get Mailings By States
- Get Mailings By Subject
- Get Mailings By Types
- Get Preview Text
- Get Template
- Get The Reply-To Address
- Mailing – Add Attachment
- Mailing – Add Custom Mailing Properties
- Mailing – Copy Attachments
- Mailing – Create Schedule
- Mailing – Delete Attachment
- Mailing – Delete Attachments
- Mailing – Delete Schedule
- Mailing – Disable QoS Checks
- Mailing – Enable Target Group Update
- Mailing – Fill RSS SmartMailing Tags
- Mailing – Get “Ignore Permission” State
- Mailing – Get “Post Sendout Cleanup” State
- Mailing – Get Archival Duration
- Mailing – Get Attachment
- Mailing – Get Attachments
- Mailing – Get Count Attachments
- Mailing – Get DOI Mailing Key
- Mailing – Get HTML
- Mailing – Get List of Custom Mailing Properties
- Mailing – Get Locale
- Mailing – Get Max Attachment Size
- Mailing – Get Max Content Size
- Mailing – Get Name
- Mailing – Get Recipient Alias
- Mailing – Get result for Link Quality Check
- Mailing – Get result for Message Size Quality Check
- Mailing – Get result for Personalization Quality Check
- Mailing – Get result for Spam Quality Check
- Mailing – Get results for Approval Sendout Quality Check
- Mailing – Get results for Attention Quality Check
- Mailing – Get results for Bounce Quality Check
- Mailing – Get results for Display Quality Check
- Mailing – Get results for Image Quality Check
- Mailing – Get results for Test Mail Sendout
- Mailing – Get Schedule
- Mailing – Get Sender Address
- Mailing – Get Sender Alias
- Mailing – Get Speed Level
- Mailing – Get State
- Mailing – Get Subject
- Mailing – Get Tags
- Mailing – Get Target Group Id
- Mailing – Get Target Group Update status
- Mailing – Get Text
- Mailing – Get Tracking Duration
- Mailing – Get Tracking Strategy
- Mailing – Get Type
- Mailing – Is Sealed
- Mailing – Remove Custom Mailing Property
- Mailing – Send Approval Mail to Targetgroup
- Mailing – Send Now
- Mailing – Send Testmail to Targetgroup
- Mailing – Set “Ignore Permission” State
- Mailing – Set “Post Sendout Cleanup” State
- Mailing – Set DOI Mailing Key
- Mailing – Set Html
- Mailing – Set Locale
- Mailing – Set Name
- Mailing – Set Recipient Alias
- Mailing – Set Sender Address
- Mailing – Set Sender Alias
- Mailing – Set Speed Level
- Mailing – Set Subject
- Mailing – Set Tags
- Mailing – Set Target Group Id
- Mailing – Set Text
- Mailing – Set Tracking Strategy
- Mailing – Start Attention Quality Check
- Mailing – Start Bounce Quality Check
- Mailing – Start Image Quality Check
- Mailing – Start Link Quality Check
- Mailing – Start Message Size Quality Check
- Mailing – Start Personalization Quality Check
- Mailing – Start Spam Quality Check
- Mailing – Update Custom Mailing Property
- Mailing – Update Schedule
- Merge Tags
- Reset Contents to Template
- Set limit on number of contacts before sending mailing
- Set Preview Text
- Set Template
- Set The Reply-To Address
- Alle Artikel anzeigen ( 86 ) Artikel zusammenklappen
-
- Bald verfügbar
-
- Bald verfügbar
-
- Bald verfügbar
Unsubscribe Contacts By Email
- Inhaltsübersicht
- Für Entwickler
- Docs
- Rest API V1
- Contacts
- Unsubscribe Contacts By Email
This method unsubscribes the contact(s) with the given email address.
Please note: as XQueue takes correct handling of contact data very serious, we anonymize all data of unsubscribed contacts, which implies anonymizing clicks, opens, contact events, etc.. To avoid ubsubscription pages having long loading times, this is an asynchronous call, which means if you ask for the contact immediatelly after unsubscribing, there is a chance, that it is still there. If you ask a couple of seconds later, it will be gone./ So if this call does not return an error code, you should display that the contact has been unsubscribed, as once the call is registered, it is immediatelly persisted and will be processed in parallel.
DELETE https://api.maileon.com/1.0/contacts/email/:email/unsubscribe
Attributes
Parameter | Default | Description |
nlaccountid | Optional multivalued parameter to define in which accounts the email should be unsubscribed. Note: The accounts must belong to the owner of the API key in use, otherwise they will be ignored. | |
mailingId | Optional parameter. If filled, the unsubscription event will be counted for the mailing with the given ID and will be visible in the reports. Note, that you will get an error ‘400 – Bad Request’, if you specify a mailing that has not been sent yet (i.e. has not the state ‘sealed’ and is still a draft). | |
reason | Optional multivalued array. If filled, the unsubscription reason will be submitted to maileon and saved in an anonymized table for reporting purposes. Unsubscription reasons have two layers of information (separated by a |, see examples): types and messages |
1. Reason-Type. Valid values are:
– too_many_messages
– no_demand
– change_of_channel
– change_of_interest
– technical_reasons
– other
2. Reason-Message. Here you can provide a custom message, especially used for tyoe ‘other’ as e.g. type too_many_messages is automatically translated to a sounding representation in the report.
Hint: for easing you evaluating your results we suggest to limit the amount of possible values e.g. by providing a dropdown box with predefined values only.
Example 1
DELETE https://api.maileon.com/1.0/contacts/email/max-mustermann@xqueue.com/unsubscribe?reason=too_many_messages&reason=other|Changed+my+email+address Content-type: application/vnd.maileon.api+xml Accept: application/vnd.maileon.api+xml Authorization: [XXX]
Status: 204 No Content Content-Type: application/vnd.maileon.api+xml
Example 2
DELETE https://api.maileon.com/1.0/contacts/email/max-mustermann@xqueue.com/unsubscribe?nlaccountid=12&nlaccountid=19 Content-type: application/vnd.maileon.api+xml Accept: application/vnd.maileon.api+xml Authorization: [XXX]
Status: 204 No Content Content-Type: application/vnd.maileon.api+xml