Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

compileCampaignRecipientResultsBackground


The asynchronous version of compileCampaignRecipientResults(). This method is invoked and
the results are emailed to the caller.

Input

[vrtypens:compileCampaignRecipientResultsArgs]

session_id [xsd:string] (required)
Your API session id.
campaign_id [xsd:int] (required)
The id of the campaign whose recipient results are being fetched.
list_name [xsd:string] (required)
The name of the new list that will be created
fields_to_include [vrtypens:ArrayOfString] (required)
An array of the names of list fields to include as fields in the result.
restrict_responses [vrtypens:ArrayOfString]
An array of the only response types that should be reported on.
Valid items for this array are:

  • OPEN
  • CLICK
  • SALE
  • BOUNCE
  • UNSUBSCRIBE
  • NONE
restrict_lists [vrtypens:ArrayOfInteger]
An array of ids of the lists whose recipients the result should be restricted to.
notification_email_address [xsd:string]
This is required for the background version of this method. When the result is ready, this email address will
receive a notification that includes a link that can be used to download the result.

Output

[xsd:int]
The output is the ID of the background task.

Examples

Perl

$vrapi->compileCampaignRecipientResultsBackground( {
    session_id => $sid,
    campaign_id => $cid,
    list_name => 'new_list_name_to_be_created',
    restrict_responses => [ "OPEN", "CLICK" ],
    notification_email_address => 'api-support@verticalresponse.com'
} );

PHP

$vrapi->compileCampaignRecipientResultsBackground( array(
    'session_id' => $sid,
    'campaign_id' => $cid,
    'list_name' => 'new_list_name_to_be_created',
    'restrict_responses' => array( "OPEN", "CLICK" ),
    'notification_email_address' => 'api-support@verticalresponse.com',
) );

Ruby

vr.compileCampaignRecipientResultsBackground({
    'session_id'  => sid,
    'campaign_id' => cid,
    'list_name'   => 'new_list_name_to_be_created',
    'restrict_responses' => [ 'OPEN', 'CLICK'],
    'notification_email_address' => 'api-support@verticalresponse.com",
})

C#.NET

compileCampaignRecipientResultsArgs objCompileRec = new compileCampaignRecipientResultsArgs();
objCompileRec.session_id = _sSessionId;k
objCompileRec.campaign_id = iCampaignId;
objCompileRec.list_name   = "new_list_name_to_be_created";
objCompileRec.restrict_responses = new string[] { "OPEN", "CLICK"}
objCompileRec.notification_email_address = "api-support@verticalresponse.com";

vr.compileCampaignRecipientResultsBackground(objCompileRec);