Campaign Unsubscriptions (Report.Campaign.Unsubscriptions)

Description

Returns unsubscription report of a specific campaign

Input Parameters

Command=Report.Campaign.Unsubscriptions [required]

Required command to perform API request

ResponseFormat [optional] [default=XML]

Defines the response data format. It can be equal to XML or JSON .

SessionID [required]

Your session ID. In order to run this API call, you need to be logged in and have session ID.

CampaignID [required]

ID number of the target campaign

Output Parameters

Success [true or false]

If an error has occurred, this parameter will be equal to false. Otherwise it will be set to true.

ErrorCode [integer]

If an error has occurred, this parameter will contain error codes. Otherwise it will be set to 0.

SessionID [string]

If login was successful, this parameter will contain the session ID that you will need on your following API calls.

Statistics [array]

An array which contains statistics data

Error Codes

#1

Campaign ID is missing

#2

Invalid campaign

#9998

Unauthorized access. User login required to execute this API call.

#9999

Invalid API call. Please check the API command and try again.