POST api/rewards/update

Updates rewards from a referral program.

Request Information

URI Parameters

Query String:

None.

Body Parameters

A list of required structures containing the details of the reward to update.

Type: Collection of UpdateReward

NameDescriptionTypeAdditional information
rewardId

The unique ID of a reward to update.

string

Required

amount

The value of the reward. Optional.

decimal number

None.

payoutId

The ID of the payout of which the reward will be based on.

string

Required

eligibilityDate

Date on which the recipient would be eligible to recieve the reward. Optional.

date

None.

description

A text field to provide additional information about the reward. Optional.

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "rewardId": "sample string 1",
    "amount": 1.0,
    "payoutId": "sample string 2",
    "eligibilityDate": "2018-04-22T04:20:32.2702606Z",
    "description": "sample string 3"
  },
  {
    "rewardId": "sample string 1",
    "amount": 1.0,
    "payoutId": "sample string 2",
    "eligibilityDate": "2018-04-22T04:20:32.2702606Z",
    "description": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfupdateReward xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <updateReward>
    <payoutId>sample string 2</payoutId>
    <eligibilityDate>2018-04-22T00:20:32.2702606-04:00</eligibilityDate>
    <description>sample string 3</description>
    <rewardId>sample string 1</rewardId>
    <amount>1</amount>
  </updateReward>
  <updateReward>
    <payoutId>sample string 2</payoutId>
    <eligibilityDate>2018-04-22T00:20:32.2702606-04:00</eligibilityDate>
    <description>sample string 3</description>
    <rewardId>sample string 1</rewardId>
    <amount>1</amount>
  </updateReward>
</ArrayOfupdateReward>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: RewardConfirmation

NameDescriptionTypeAdditional information
reward

Structure containing details about a reward

Reward

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "reward": {
    "id": "bcfcaf70-e827-4905-9d62-859331663cb4",
    "payoutId": "46ad8576-fdc6-4825-b04d-57043f024e90",
    "payoutDescription": "sample string 3",
    "programId": "3fb5980f-1fac-4fad-b0ca-355be8e72777",
    "programName": "sample string 5",
    "memberId": "d3e66de6-48fe-477c-a387-97c3a24d22a9",
    "referralId": "8e2eaf19-c6dc-4fb5-a8af-b01e93f5fa9e",
    "type": "sample string 6",
    "recipientId": "9520d631-2ef6-4989-9122-48878129331d",
    "recipientName": "sample string 7",
    "recipientEmailAddress": "sample string 8",
    "status": "sample string 9",
    "amount": 10.0,
    "createDate": "2018-04-22T04:20:32.2942612Z",
    "issueDate": "2018-04-22T04:20:32.2942612Z",
    "eligibilityDate": "2018-04-22T04:20:32.2942612Z",
    "description": "sample string 13"
  }
}

application/xml, text/xml

Sample:
<rewardConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <reward>
    <id>bcfcaf70-e827-4905-9d62-859331663cb4</id>
    <payoutId>46ad8576-fdc6-4825-b04d-57043f024e90</payoutId>
    <payoutDescription>sample string 3</payoutDescription>
    <programId>3fb5980f-1fac-4fad-b0ca-355be8e72777</programId>
    <programName>sample string 5</programName>
    <memberId>d3e66de6-48fe-477c-a387-97c3a24d22a9</memberId>
    <referralId>8e2eaf19-c6dc-4fb5-a8af-b01e93f5fa9e</referralId>
    <type>sample string 6</type>
    <recipientId>9520d631-2ef6-4989-9122-48878129331d</recipientId>
    <recipientName>sample string 7</recipientName>
    <recipientEmailAddress>sample string 8</recipientEmailAddress>
    <status>sample string 9</status>
    <amount>10</amount>
    <createDate>2018-04-22T00:20:32.2942612-04:00</createDate>
    <issueDate>2018-04-22T00:20:32.2942612-04:00</issueDate>
    <eligibilityDate>2018-04-22T00:20:32.2942612-04:00</eligibilityDate>
    <description>sample string 13</description>
  </reward>
</rewardConfirmation>