DeleteCampaign

Deletes the campaign.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions 4 and 5, see the Migration guide.

The DeleteCampaign (Live) version also exists for this method.

When a campaign is deleted, the campaign records are deleted from the database. You cannot get information about a deleted campaign.

Restrictions

You can only delete a campaign that has “Draft” status, that has not had any funds credited to its account, and that has not accumulated statistics. For other campaigns, archiving is available using the ArchiveCampaign method.

If the advertiser has the shared account enabled and there are funds on the shared account, deleting the only campaign is not allowed.

Attention. This method only supports campaigns with the “Text & Image Ads” type. To work with all types of campaigns, use the Campaigns service in version 5 of the API. More information about campaign types

Input data

The input data structure in JSON is shown below.

{
   "method": "DeleteCampaign",
   "param": {
      /* CampaignIDInfo */
      "CampaignID": (int)
   }
}

Parameters are described below.

ParameterDescriptionRequired
CampaignIDInfo object
CampaignIDThe campaign ID.Yes

Output data

Returns 1 when deleted successfully, as shown in the following example.

{
   "data": 1
}

Examples of input data

Python

{
   'CampaignID': 3665578
}

PHP

array(
   'CampaignID' => 3665578
)

Perl

{
   'CampaignID' => 3665578
}