API DOCUMENTATION Last Update: Apr 2022

Delete a Campaign

Removes a campaign from an account, including all customer transactions in it.


The data to be submitted to the API is composed of the following fields:


  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
type campaign_delete Required
action campaign Required
account_id greatwidgets Required
campaign_id 1234567890123456 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output



  • The ability to delete campaigns is based on the permissions of the user_id that is making the call.
  • Only one campaign can be deleted at a time. Loop this call in your program to delete multiple campaigns.
  • Deactivating a campaign removes it from the list of campaigns that is returned in many other calls, without deleting any data associated with it (settings, customer transactions, etc.) This is often used to "turn off" recurring seasonal campaigns.


Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'campaign_delete';
  4. $data['action'] = 'campaign';
  5. $data['account_id'] = 'greatwidgets';
  6. $data['campaign_id'] = '1234567890123456';


Success XML Response:

  1. <response status="success">
  2. <campaign status="deleted">
  3. <id>1234567890123456</id>
  4. </campaign>
  5. </response>


Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>