|
Create New Campaign Fee
Create a new campaign fee in an existing account.
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_fee_new |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
campaign_id |
|
1234567890123456 |
|
Required |
|
|
|
fee_interval |
|
18 |
|
Required |
|
|
|
interval_type |
|
days or
months or
years
|
|
Required |
|
|
|
fee_amount |
|
100 points or money
depending on campaign type |
|
Required |
|
|
|
fee_description |
|
Service Charge |
|
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 |
|
|
|
|
|
|
|
|
|
Notes:
- 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:
- $data['user_id'] = 'john1970';
- $data['user_password'] = '1959caadac9b13dcb3';
- $data['type'] = 'campaign_fee_new';
- $data['account_id'] = 'greatwidgets';
- $data['campaign_id'] = '1234567890123456';
- $data['fee_interval'] = '18';
- $data['interval_type'] = 'months';
- $data['fee_amount'] = '100';
- $data['fee_description'] = 'Service Charge';
Success XML Response:
- <response status="success">
- <fee status="new">
- <id>453</id>
- <interval>18</interval>
- <interval_type>months</interval_type>
- <amount>100</amount>
- <description>100</description>
- </fee>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|
|
|