API DOCUMENTATION Last Update: Apr 2022

Triggers - List

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

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

 

  field   Example   Note
API 1.5 Required
user_id john1970 Required
user_api_key 1959ca5645adac9b13dcb3 Required
account_id greatwidgets Required
type manage_campaign_triggers Required
action list 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

 

 

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_triggers';
  5. $data['action'] = 'list';
  6. $data['account_id'] = 'greatwidgets';

 

Success XML Response

  1. <response status="success">
  2. <triggers>
  3. <trigger_id>210</trigger_id>
  4. <trigger_name>Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm</trigger_name>
  5. <trigger_time_start>16:00:00</trigger_time_start>
  6. <trigger_time_validity>2</trigger_time_validity>
  7. <trigger_active_days>1,3</trigger_active_days>
  8. <trigger_campaing_id_from>5095775700340492</trigger_campaing_id_from>
  9. <trigger_threshold_amount>1000</trigger_threshold_amount>
  10. <trigger_apply_to_all_transactions>Y</trigger_apply_to_all_transactions>
  11. <trigger_deduct_from_balance>N</trigger_deduct_from_balance>
  12. <trigger_deduct_from_balance_repeat>N</trigger_deduct_from_balance_repeat>
  13. <trigger_action_type>add</trigger_action_type>
  14. <trigger_action_amount>50</trigger_action_amount>
  15. <trigger_campaing_id_to>6017673775945338</trigger_campaing_id_to>
  16. <trigger_action_type>add</trigger_action_type>
  17. <trigger_buyx_to_item_description></trigger_buyx_to_item_description>
  18. <trigger_type>C</trigger_type>
  19. </triggers>
  20. </response>

Error XML Response:

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