Delete a BuyX Campaign Item

Removes an item from an existing Buy X Get 1 Free campaign.

Headers

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

Notes:

• Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.

• The ability to delete BuyX campaign items is based on the permissions of the user_id that is making the call.
• When identifying the item to the API with the parameter item_id, you MUST use the <id> that is returned in the XML construct as the result of a call like Campaign - List BuyX Items, NOT the <reward_id> which corresponds to the optional reward_identifier field.
• Only one item can be deleted at a time. Loop this call in your program to delete multiple items.

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'] = 'item';
5. $data['account_id'] = 'greatwidgets';
6. $data['campaign_id'] = '1234567890123456';
7. $data['item_id'] = '678';

Success XML Response:

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

Error XML Response:

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