Delete a Reward
Removes a reward from an account's 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_delete |
|
Required |
|
|
|
action |
|
reward |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
campaign_id |
|
1234567890123456 |
|
Required |
|
|
|
reward_id |
|
432 |
|
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 delete rewards is based on the permissions of the user_id that is making the call.
- When identifying the reward to the API, you MUST use the <id> that is returned in the XML constructs, NOT the <reward_id> which corresponds to an optional reward_identifier field.
- Only one reward can be deleted at a time. Loop this call in your program to delete multiple rewards.
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_delete';
- $data['action'] = 'reward';
- $data['account_id'] = 'greatwidgets';
- $data['campaign_id'] = '1234567890123456';
- $data['reward_id'] = '432';
Success XML Response:
- <response status="success">
- <reward status="deleted">
- <id>432</id>
- </reward>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|