API DOCUMENTATION Last Update: Apr 2022

Create New Campaign Reward

Add a new reward to an existing Points or Event-based 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_new Required
action reward Required
account_id greatwidgets Required
campaign_id 1234567890123456 Required
reward_level 1000 Required
reward_description Free Widget Required
reward_identifier 1010101 Optional
reward_custom_field## Reward data here based on your custom reward field Optional
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



  • The ability to create rewards is based on the permissions of the user_id that is making the call.
  • Only one reward can be added at a time. Loop this call in your program to add multiple rewards at the same time.
  • This call applies only to Points and Event-Based campaigns.
  • Custom reward fields need to be created first in order to store information in them.
  • The reward_level is an amount that is depedent on the campaign type. For example:
    • For Points-based campaigns: 1000 points = Free Widget
    • For Event-based campaigns: 15 events = Free Widget
  • The reward_identifier is an optional field that lets you specify a reward id such as a SKU, used mostly for 3rd party fullfilment integrations. Please note that when identifying the reward to the API, you MUST use the <id> that is returned in the XML construct, NOT the <reward_id> which corresponds to this optional reward_identifier field.


    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_new';
    4. $data['action'] = 'reward';
    5. $data['account_id'] = 'greatwidgets';
    6. $data['campaign_id'] = '1234567890123456';
    7. $data['reward_level'] = '1000';
    8. $data['reward_description'] = 'Free Widget';
    9. $data['reward_identifier'] = '1010101';
    10. $data['reward_custom_field_1'] = '77654457';


    Success XML Response:

    1. <response status="success">
    2. <campaign>
    3. <reward>
    4. <id>14</id>
    5. </reward>
    6. </campaign>
    7. </response>


    • A successful result will return the reward_id of the reward. This id can also be retrieved with the Campaign - List Rewards API call.


    Error XML Response:

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