Create New Campaign Fee

Create a new campaign fee in an existing account.

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.

• The ability to add a fee is based on the permissions of the user_id that is making the call.
• Only one fee can be added at a time.
  • Fees can only be created for Points and GiftCard (stored value) type of campaigns.
  • The fee_interval and interval_type specify the amount of time until the fee will be applied. For example "18" + "months" means that after 18 months the fee will apply.

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_fee_new';
4. $data['account_id'] = 'greatwidgets';
5. $data['campaign_id'] = '1234567890123456';
6. $data['fee_interval'] = '18';
7. $data['interval_type'] = 'months';
8. $data['fee_amount'] = '100';
9. $data['fee_description'] = 'Service Charge';

Success XML Response:

1. <response status="success">
2. <fee status="new">
3. <id>453</id>
4. <interval>18</interval>
5. <interval_type>months</interval_type>
6. <amount>100</amount>
7. <description>100</description>
8. </fee>
9. </response>

Error XML Response:

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