POST api/rewards/remove

Deletes a reward from a member or referral of a referral program.

Request Information

URI Parameters

Query String:

None.

Body Parameters

Type: Collection of string

Request Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: Collection of RemoveRewardResult

NameDescriptionTypeAdditional information
rewardId

Echos the reward ID sent in the request.

string

None.

resultInfo

Details about the results of the request.

ResultInfo

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "rewardId": "sample string 1",
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  },
  {
    "rewardId": "sample string 1",
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfremoveRewardResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <removeRewardResult>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
    <rewardId>sample string 1</rewardId>
  </removeRewardResult>
  <removeRewardResult>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
    <rewardId>sample string 1</rewardId>
  </removeRewardResult>
</ArrayOfremoveRewardResult>