GetCampaigns

This method retrieves all existing campaigns within the account. It will not return the actual content of the campaigns.

The select parameter requires a number between 1 and 1000 (0 is not a valid number).

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. This parameter goes within the URL.

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

📘

Input and output parameters

The input and output parameters for this method are:

Input parameters

• Select - optional; integer
• Skip - optional; integer

Output parameters

• GetCampaignsResult - 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 select = 1000;
	var skip = 0;
	var campaigns = client.GetCampaigns(select, skip);
}