API DOCUMENTATION Last Update: Apr 2022

Campaign Depreciations List

Returns a list of the depreciations for a given campaign.


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_depreciations 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



  • Depreciations are only available for Points and GiftCard (Stored Value) type of 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_depreciations';
  4. $data['account_id'] = 'greatwidgets';
  5. $data['campaign_id'] = '1234567890123456';


Success XML Response:

  1. <response status="success">
  2. <campaign>
  3. <id>1111222233334444</id>
  4. </campaign>
  5. <depreciations>
  6. <depreciation>
  7. <id>356</id>
  8. <depreciation_interval>18</depreciation_interval>
  9. <depreciation_interval_type>months</depreciation_interval_type>
  10. <depreciation_percentage>50</depreciation_percentage>
  11. </depreciation>
  12. <depreciation>
  13. <id>417</id>
  14. <depreciation_interval>4</depreciation_interval>
  15. <depreciation_interval_type>years</depreciation_interval_type>
  16. <depreciation_percentage>100</depreciation_percentage>
  17. </depreciation>
  18. ...
  19. </depreciations>
  20. </response>


  • When identifying a depreciation entry to another API call, you use the <id> that is returned in the XML construct such as the one above.


Error XML Response:

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