boosts - List

Retrieves the list of the existing boosts that are configured in a given account.

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

Example PHP Request:

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

1. $data['API'] = '1.5';
2. $data['user_id'] = 'john1970';
3. $data['user_api_key'] = '1959caadac9b13dcb3';
4. $data['type'] = 'manage_campaign_boosts';
5. $data['action'] = 'list';
6. $data['account_id'] = 'greatwidgets';

Success XML Response

1. <response status="success">
2. <boosts>
3. <boost_id>210</boost_id>
4. <boost_name>Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm</boost_name>
5. <boost_time_start>16:00:00</boost_time_start>
6. <boost_time_validity>2</boost_time_validity>
7. <boost_active_days>1,3</boost_active_days>
8. <boost_campaing_id_from>5095775700340492</boost_campaing_id_from>
9. <boost_threshold_amount>1000</boost_threshold_amount>
10. <boost_apply_to_all_transactions>Y</boost_apply_to_all_transactions>
11. <boost_deduct_from_balance>N</boost_deduct_from_balance>
12. <boost_deduct_from_balance_repeat>N</boost_deduct_from_balance_repeat>
13. <boost_action_type>add</boost_action_type>
14. <boost_action_amount>50</boost_action_amount>
15. <boost_campaing_id_to>6017673775945338</boost_campaing_id_to>
16. <boost_action_type>add</boost_action_type>
17. <boost_buyx_to_item_description></boost_buyx_to_item_description>
18. <boost_type>C</boost_type>
19. </boosts>
20. </response>

Error XML Response:

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