GetCampaignsForAddressBook

Gets any campaigns that have been sent to an address book or segment

This method will return any campaigns that you have sent to a specified address book or segment. This can be useful in ensuring that you do not send the same campaign to the same contacts.

However, remember that the filter is based on the address book or segment, so if the contacts in the address book or segment are changed it will show the address book or segment as still having been sent the campaign, even though the contacts within might not have received that particular campaign.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

SOAP action: http://apiconnector.com/v2/ApiService/GetCampaignsForAddressBook

πŸ“˜

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • AddressBookId - required; integer
  • Select - optional; integer
  • Skip - optional; integer

Output parameters

  • GetCampaignsForAddressBookResult - array of Campaign
    • Campaign
      • Id - integer
      • Name - string
      • Subject - string
      • FromName - string
      • FromAddress
        • Id - integer
        • Email - string
      • HtmlContent - string
      • PlainTextContent - string
      • ReplyAction - string (Unset', 'WebMailForward', 'Webmail', 'Delete')
      • ReplyToAddress - string
      • IsSplitTest - boolean
      • Status - string ('Unsent', 'Sending', 'Sent', 'Paused', 'Cancelled', 'RequiresSystemApproval', 'RequiresSMSApproval', 'RequiresWorkflowApproval', 'Triggered')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var addressBookId = 1;
	var select = 1000;
	var skip = 0;
	var campaigns = client.GetCampaignsForAddressBook(addressBookId, select, skip);
}