A fixed trigger is an action that will be executed automatically in all customer accounts that belong to a Loyalty Program Campaign (e.g. Points Program) when they meet certain conditions. For example: Get $10 in your Gift Card account (cash-back) for each 1000 points that you earn.
See moreAllows to update an existing Trigger.
See moreAllows you to create a Temporary Trigger which is a trigger that will be active only during a certain date/time frame.
See moreAllows you to update the configuration of an existing Trigger.
See moreAllows you to create a Recurring Trigger, which is a trigger that will be active only during a recurring period of time. Example: Tuesdays from 5pm- 7pm.
See moreAllows you to update the configuration of an existing Trigger.
See moreRetrieves the configuration details of an existing Trigger.
See moreRetrieves the list of the existing triggers that are configured in a given account.
See moreDeletes a Trigger permanently.
See moreFixed Trigger - Create New
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | new | Required | ||||
account_id | greatwidgets | Required | ||||
trigger_name | Get $10 for each 1000 points earned | Required | ||||
trigger_type | A | Required See Notes |
||||
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
||||
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A or B | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'new';
$data['trigger_type'] = 'A'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'N';
$data['trigger_deduct_from_balance'] = 'Y';
$data['trigger_deduct_from_balance_repeat'] = 'Y';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '10';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get $10 for each 1000 points earned';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Fixed Trigger - Update
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | update | Required | ||||
account_id | greatwidgets | Required | ||||
trigger_id | 208 | Required | ||||
trigger_name | Get $10 for each 1000 points earned | Required | ||||
trigger_type | A | Required See Notes |
||||
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
||||
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A or B | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'update';
$data['trigger_id'] = '208'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_type'] = 'A'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'N';
$data['trigger_deduct_from_balance'] = 'Y';
$data['trigger_deduct_from_balance_repeat'] = 'Y';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '10';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get $10 for each 1000 points earned';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Temporary Trigger - Create New
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | new | Required | ||||
account_id | greatwidgets | Required | ||||
trigger_name | Get $10 Gift for each 1000 points earned only from Dec 1st - 15th | Required | ||||
trigger_type | B | Required See Notes |
||||
trigger_date_start | 2018-12-01 | Required See Notes |
||||
trigger_time_start | 00:00:00 | Optional See Notes |
||||
trigger_time_validity | 15 | Optional See Notes |
||||
trigger_interval_type | D | Optional See Notes |
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
|
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'new';
$data['trigger_type'] = 'B'
$data['trigger_date_start'] = '2018-12-01'
$data['trigger_time_start'] = '00:00:00'
$data['trigger_time_validity'] = '15'
$data['trigger_interval_type'] = 'D'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'N';
$data['trigger_deduct_from_balance'] = 'Y';
$data['trigger_deduct_from_balance_repeat'] = 'Y';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '10';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get $10 Gift for each 1000 points earned only from Dec 1st - 15th';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Temporary Trigger - Update
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | update | Required | ||||
account_id | greatwidgets | Required | trigger_id | 209 | Required | |
trigger_name | Get $10 Gift for each 1000 points earned only from Dec 1st - 15th | Required | ||||
trigger_type | B | Required See Notes |
||||
trigger_date_start | 2018-12-01 | Required See Notes |
||||
trigger_time_start | 00:00:00 | Optional See Notes |
||||
trigger_time_validity | 15 | Optional See Notes |
||||
trigger_interval_type | D | Optional See Notes |
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
|
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A or B | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'update';
$data['trigger_type'] = 'B'
$data['trigger_id'] = '209'
$data['trigger_date_start'] = '2018-12-01'
$data['trigger_time_start'] = '00:00:00'
$data['trigger_time_validity'] = '15'
$data['trigger_interval_type'] = 'D'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'N';
$data['trigger_deduct_from_balance'] = 'Y';
$data['trigger_deduct_from_balance_repeat'] = 'Y';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '10';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get $10 Gift for each 1000 points earned only from Dec 1st - 15th';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Recurring Trigger - Create New
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | new | Required | ||||
account_id | greatwidgets | Required | ||||
trigger_name | Get $10 for each 1000 points earned | Required | ||||
trigger_type | C | Required See Notes |
||||
trigger_time_start | 16:00:00 | Optional See Notes |
||||
trigger_time_validity | 2 | Optional See Notes |
||||
trigger_active_days | 1,3 | Optional See Notes |
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
|
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A or B | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'new';
$data['trigger_type'] = 'C'
$data['trigger_time_start'] = '16:00:00'
$data['trigger_time_validity'] = '2'
$data['trigger_active_days'] = '1,3'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'Y';
$data['trigger_deduct_from_balance'] = 'N';
$data['trigger_deduct_from_balance_repeat'] = 'N';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '50';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Recurring Trigger - Update
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 | 1959caadac9b13dcb3 | Required | ||||
type | manage_campaign_triggers | Required | ||||
action | update | Required | ||||
account_id | greatwidgets | Required | ||||
trigger_id | 210 | Required | ||||
trigger_name | Get $10 for each 1000 points earned | Required | ||||
trigger_type | C | Required See Notes |
||||
trigger_time_start | 16:00:00 | Optional See Notes |
||||
trigger_time_validity | 2 | Optional See Notes |
||||
trigger_active_days | 1 | Optional See Notes |
trigger_campaign_id_from | 1234567890123456 | Required See Notes |
|
trigger_buyx_from_item_description | Coffee | Optional See Notes |
||||
trigger_threshold_amount | 1000 | Required See Notes |
||||
trigger_apply_to_all_transactions | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance | Y or N | Optional See Notes |
||||
trigger_deduct_from_balance_repeat | Y or N | Optional See Notes |
||||
trigger_action_type | add or multiply | Required See Notes |
||||
trigger_action_amount | 10 | Required | ||||
trigger_action_rule | A or B | Optional See Notes |
||||
trigger_campaing_id_to | 5555554567890123456 | Required See Notes |
||||
trigger_buyx_to_item_description | Dessert | Optional See Notes |
||||
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 |
Notes:
Example PHP Request:
If you are using PHP, the $data array would look like this:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'update';
$data['trigger_type'] = 'C'
$data['trigger_id'] = '210'
$data['trigger_time_start'] = '16:00:00'
$data['trigger_time_validity'] = '2'
$data['trigger_active_days'] = '1,3'
$data['trigger_campaing_id_from'] = '5095775700340492'
$data['trigger_threshold_amount'] = '1000';
$data['trigger_apply_to_all_transactions'] = 'Y';
$data['trigger_deduct_from_balance'] = 'N';
$data['trigger_deduct_from_balance_repeat'] = 'N';
$data['trigger_action_type'] = 'add';
$data['trigger_action_amount'] = '50';
$data['trigger_campaing_id_to'] = '6017673775945338';
$data['trigger_name'] = 'Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm';
Success XML Response:
<response status="success">
<trigger_id>208</trigger_id>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Triggers - Retrieve Information
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 | info | Required | ||||
trigger_id | 210 | 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:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'info';
$data['account_id'] = 'greatwidgets';
$data['trigger_id'] = '210';
Success XML Response
<response status="success">
<triggers>
<trigger_id>210</trigger_id>
<trigger_name>Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm</trigger_name>
<trigger_time_start>16:00:00</trigger_time_start>
<trigger_time_validity>2</trigger_time_validity>
<trigger_active_days>1,3</trigger_active_days>
<trigger_campaing_id_from>5095775700340492</trigger_campaing_id_from>
<trigger_threshold_amount>1000</trigger_threshold_amount>
<trigger_apply_to_all_transactions>Y</trigger_apply_to_all_transactions>
<trigger_deduct_from_balance>N</trigger_deduct_from_balance>
<trigger_deduct_from_balance_repeat>N</trigger_deduct_from_balance_repeat>
<trigger_action_type>add</trigger_action_type>
<trigger_action_amount>50</trigger_action_amount>
<trigger_campaing_id_to>6017673775945338</trigger_campaing_id_to>
<trigger_action_type>add</trigger_action_type>
<trigger_buyx_to_item_description></trigger_buyx_to_item_description>
<trigger_type>C</trigger_type>
</triggers>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Triggers - List
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:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'list';
$data['account_id'] = 'greatwidgets';
Success XML Response
<response status="success">
<triggers>
<trigger_id>210</trigger_id>
<trigger_name>Get 50 Bonus Points in each visit Mondays and Wednesdays 4pm to 6pm</trigger_name>
<trigger_time_start>16:00:00</trigger_time_start>
<trigger_time_validity>2</trigger_time_validity>
<trigger_active_days>1,3</trigger_active_days>
<trigger_campaing_id_from>5095775700340492</trigger_campaing_id_from>
<trigger_threshold_amount>1000</trigger_threshold_amount>
<trigger_apply_to_all_transactions>Y</trigger_apply_to_all_transactions>
<trigger_deduct_from_balance>N</trigger_deduct_from_balance>
<trigger_deduct_from_balance_repeat>N</trigger_deduct_from_balance_repeat>
<trigger_action_type>add</trigger_action_type>
<trigger_action_amount>50</trigger_action_amount>
<trigger_campaing_id_to>6017673775945338</trigger_campaing_id_to>
<trigger_action_type>add</trigger_action_type>
<trigger_buyx_to_item_description></trigger_buyx_to_item_description>
<trigger_type>C</trigger_type>
</triggers>
</response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>
Triggers - Delete
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 | delete | Required | ||||
trigger_id | 210 | 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:
$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'manage_campaign_triggers';
$data['action'] = 'delete';
$data['account_id'] = 'greatwidgets';
$data['trigger_id'] = '210';
Success XML Response:
<response status="success"></response>
Error XML Response:
<response status="error">
<error>Error message</error>
</response>