Temporary boost - Update

Allows you to update the configuration of an existing boost.

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.

• boost Types: A= Fixed (does not have an expiration date), B= Temporary (active only for a certain period of time), and C = Recurring (active only during certain days/hours)
• Campaign ID from is the Campaign ID where the boost is originated from. For example, if your boost is Get $10 in your Gift Card Account for each 1000 points that you earn, your campaign_id_from will be the ID of the Points Campaign where you are tracking the points that customers are earning.
• boost buyx from item description is applicable only if the boost_campaing_id_from is a campaign type Buy X Get 1 Free. For example: If your boost is Buy 9 Coffees Get automatically a Free Dessert, "Coffee" will be the buyx item description.
• boost amount is the threshold value that customers have to meet for the boost to get executed. Example: Get $10 in your Gift Card Account for each 1000 points boost, the boost_amount will be 1000.
• boost apply to all transactions is an option to apply the boost action to all transactions received. Example: Get $0.25 in your Gift Card Account each time you earn points.
• boost deduct from balance allows to deduct from the customer balance the threshold amount. Example: in the Get $10 in your Gift Card Account for each 1000 points boost, the 1000 points will be deducted from the customer points balance.
• boost deduct from balance repeat allows to keep deducting the threshold amount as long as there is enough balance available. Use N (No) to deduct it only once.
• boost threshold amount is the value that will be added to the customer account as a result of the boost.
• boost action type can be: "add" (to add a value to the customer account as a result of the boost) or "multiply" (to multiply the transaction amount (boost threshold) by a set number in order to determine the value that will be added to the customer account as a result of the boost).
• Include boost_action-rule only if any of the two types are applicable. A= boost_include_transaction_amount (to add the transaction amount (monetary or points) to the value that will be added to the customer account as a result of the boost) and B=boost_apply_to_points_earned (applies the action amount to the points earned in a transaction instead of the value of the monetary transaction).
• boost campaing id to is the campaign where the boost value will be added to. Example: in the Get $10 in your Gift Card Account for each 1000 points boost it will be the Gift Card Campaign.
• boost buyx to item description is used only when the boost is configured for a Buy X Get 1 Free campaign. The item description is the name of the buyx item (or items) used as rewards (result of the boost). If multiple items will be added as a result of the boost use commas to separate each item.

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['account_id'] = 'greatwidgets';
5. $data['type'] = 'manage_campaign_boosts';
6. $data['action'] = 'update';
7. $data['boost_type'] = 'B'
8. $data['boost_id'] = '209'
9. $data['boost_date_start'] = '2018-12-01'
10. $data['boost_time_start'] = '00:00:00'
11. $data['boost_time_validity'] = '15'
12. $data['boost_interval_type'] = 'D'
13. $data['boost_campaing_id_from'] = '5095775700340492'
14. $data['boost_threshold_amount'] = '1000';
15. $data['boost_apply_to_all_transactions'] = 'N';
16. $data['boost_deduct_from_balance'] = 'Y';
17. $data['boost_deduct_from_balance_repeat'] = 'Y';
18. $data['boost_action_type'] = 'add';
19. $data['boost_action_amount'] = '10';
20. $data['boost_campaing_id_to'] = '6017673775945338';
21. $data['boost_name'] = 'Get $10 Gift for each 1000 points earned only from Dec 1st - 15th';

Success XML Response:

1. <response status="success">
2. <boost_id>208</boost_id>
3. </response>

Error XML Response:

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