Sample calls
This is a sample call by the "Unsubscribe" webhook for the customer "johnsmith@yahoo.com", unsubscribing from list #2.
Unsubscribe call
unsubscribeDate=2012-12-10T17%3a41%3a03.695%2b01&customerEmail=johnsmith%40yahoo.com&customerList=2
Remember that:
- The variables in the querystring can use any name. You set the variable name when creating the Parameters for the webhook in the MailUp admin console.
- You may encrypt the data passed in the callback. In the querystring shown above, the data is not encrypted.
- Dates are passed in the ISO format (YYYY-MM-DD)
Unsubscribing a recipient in a different list
One of the uses for Webhooks is to trigger an unsubscribe in a different List within your account. For example, let's say that you make an API call to unsubscribe a recipient from List 1 using the xmlunsubscribe.aspx page, and then need the same recipient to also be unsubscribed from List 2. Instead of making multiple API calls, you can accomplish the same goal by using Webhooks.
Create a new Webhook, and configure it as follows:
- Name: enter a descriptive name
URL:
http://[account_URL]//frontend/Xmlunsubscribe.aspx?ListGuid=[LIST_GUID]&List=[LIST_ID]
- Account_URL = the first portion of the URL to your admin console (e.g. d0i4e.s836.it)
- LIST_GUID = the unique identifier for the target list (e.g. f34e5054-5253-4c90-ac54-57hdepoghwph323)
- LIST_ID = the List number (e.g. 2)
- Type: Unsubscribe
- Source: API
- Parameters
- email = [email]
Related articles