downloadCompanyUnsubscribesAndBounces

The downloadCompanyUnsubscribesAndBounces() method creates a file containing all the unsubscribe and bounce records available for the company calling it. This file is returned as a FileSpec in which the location field indicates a URL pointing to the generated file. To return only unsubscribe events that are not related to any campaign, set the “exclude_campaign_unsubs” argument to true.If your unsubscribes and bounces are linked to other companies within your organization, set the “include_org_linked_unsubs” argument to true to include unsubscribes and bounces from those other companies as well. The downloaded file will contain the email address, the event (UNSUBSCRIBE or BOUNCE), and the event date. If the “exclude_campaign_unsubs” argument is not used, the file will also contain a campaign id for those records that are associated with any campaign.This method is now capable of returning the event date in UTC instead of the user’s timezone, which greatly increases the execution speed. This is handled through a new boolean parameter: UTC_date.

Input

[vrtypens:downloadCompanyUnsubscribesAndBouncesArgs]

session_id [xsd:string] (required)

Your API session id.

delimiter [xsd:string] (required)

The type of result file to create: either “csv” or “tab”.

include_org_linked_unsubs [xsd:boolean]

Whether to include unsubscribes from other companies who share unsubscribes with
the caller’s company through an organization (default is false).

exclude_campaign_unsubs [xsd:boolean]

Whether to exclude unsubscribes that exist as the result of a recipient clicking
the “unsubscribe” link in a campaign (default is false).

start_date [xsd:string]

If specified, no unsubscribes or bounces before this date will be included in the result.
This date/time should be specified in ISO 8601 format.

end_date [xsd:string]

If specified, no unsubscribes or bounces after this date will be included in the result.
This date/time should be specified in ISO 8601 format.

utc_date [xsd:boolean]

Method is now capable of returning the event date in UTC instead of the customers timezone

which greatly increases the execution speed. This is handled through this new boolean parameter.

Output

[vrtypens:downloadCompanyUnsubscribesAndBouncesResult]

Examples

PHP

$vr->downloadCompanyUnsubscribesAndBounces( array(
	'session_id' => $sid,
	'delimiter' => 'tab',
) );

Ruby

vr.downloadCompanyUnsubscribesAndBounces({
	'session_id' => sid,
	'delimiter' => 'tab',
})

Java

DownloadCompanyUnsubscribesAndBouncesArgs downloadCompanyUnsubscribesAndBouncesArgs = new DownloadCompanyUnsubscribesAndBouncesArgs();
	downloadCompanyUnsubscribesAndBouncesArgs.setSession_id(sessionID);
	downloadCompanyUnsubscribesAndBouncesArgs.setDelimiter("tab");

DownloadCompanyUnsubscribesAndBouncesResult unsub_result = vr.downloadCompanyUnsubscribesAndBounces(downloadCompanyUnsubscribesAndBouncesArgs);

C#.NET

downloadCompanyUnsubscribesAndBouncesArgs objGetBouncesUnsubscribes = new downloadCompanyUnsubscribesAndBouncesArgs();
	objGetBouncesUnsubscribes.session_id = _sSessionId;
	objGetBouncesUnsubscribes.delimiter = strDelimiter;

objVR.downloadCompanyUnsubscribesAndBounces(objGetBouncesUnsubscribes);

Perl

$vrapi->downloadCompanyUnsubscribesAndBounces( {
	session_id => $sid,
	delimiter => 'tab',
} );

Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!