Campaign_Get_Unsubscribed_Contacts

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you. Your first parameter should be the second parameter in the signature.

Description

Get a list of all Contacts who Unsubscribed from the specified Campaign

A timeString can be any of:
- A specified date/time in the format: YYYY-MM-DD
- A relative time string including, but not limited to:
* "now"
* "today"
* "tomorrow"
* "first day of January 2010" (example)
* "last day of March 2010" (example)
* "Monday this week" (example)
* "Tuesday next week" (example)

Parameters

string

key

Your API key - used to authenticate your account

int

campaignId

The campaign you wish to find contacts who unsubscribed from said campaign

optional

struct

optionalParameters

A struct of optional parameters, see below for valid keys

optionalParameters can include:

timeString

minDate

Find only Contacts who unsubscribed from this campaign on or after this date

timeString

maxDate

Find only Contacts who unsubscribed from this campaign on or before this date