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
Name | Description | Type | Additional 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
[ { "rewardId": "sample string 1", "amount": 1.0, "payoutId": "sample string 2", "eligibilityDate": "2024-04-19T19:31:25.0189344Z", "description": "sample string 3" }, { "rewardId": "sample string 1", "amount": 1.0, "payoutId": "sample string 2", "eligibilityDate": "2024-04-19T19:31:25.0189344Z", "description": "sample string 3" } ]
application/xml, text/xml
<ArrayOfupdateReward xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <updateReward> <payoutId>sample string 2</payoutId> <eligibilityDate>2024-04-19T19:31:25.0189344+00:00</eligibilityDate> <description>sample string 3</description> <rewardId>sample string 1</rewardId> <amount>1</amount> </updateReward> <updateReward> <payoutId>sample string 2</payoutId> <eligibilityDate>2024-04-19T19:31:25.0189344+00: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
Name | Description | Type | Additional 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
{ "message": "sample string 1", "reward": { "id": "7f925140-157f-469d-84ea-156f47baea71", "payoutId": "10f35d2a-b3fb-472a-bb40-0207f06986f9", "payoutDescription": "sample string 3", "programId": "86f73d02-10cd-4de3-b01e-bb7538e55181", "programName": "sample string 5", "memberId": "f89aa0bd-8dfb-4d12-b2f5-e2f1392cc9c5", "referralId": "9b5c7051-a0cc-457b-a976-3bd481146944", "type": "sample string 6", "recipientId": "4cffc063-b087-4368-958a-35d564de1b54", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "recipientExternalIdentifier": "sample string 9", "externalIdentifier": "sample string 10", "status": "sample string 11", "amount": 12.0, "createDate": "2024-04-19T19:31:25.0189344Z", "issueDate": "2024-04-19T19:31:25.0189344Z", "eligibilityDate": "2024-04-19T19:31:25.0189344Z", "description": "sample string 15", "transactionID": "3570f6b1-9941-44bf-a5ff-203c990fe17d", "updateDate": "2024-04-19T19:31:25.0189344Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "82d9224b-bdf1-4dd2-a8f5-e58adc559fe1", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22" } }
application/xml, text/xml
<rewardConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <message>sample string 1</message> <reward> <id>7f925140-157f-469d-84ea-156f47baea71</id> <payoutId>10f35d2a-b3fb-472a-bb40-0207f06986f9</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>86f73d02-10cd-4de3-b01e-bb7538e55181</programId> <programName>sample string 5</programName> <memberId>f89aa0bd-8dfb-4d12-b2f5-e2f1392cc9c5</memberId> <referralId>9b5c7051-a0cc-457b-a976-3bd481146944</referralId> <type>sample string 6</type> <recipientId>4cffc063-b087-4368-958a-35d564de1b54</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <recipientExternalIdentifier>sample string 9</recipientExternalIdentifier> <externalIdentifier>sample string 10</externalIdentifier> <status>sample string 11</status> <amount>12</amount> <createDate>2024-04-19T19:31:25.0189344+00:00</createDate> <issueDate>2024-04-19T19:31:25.0189344+00:00</issueDate> <eligibilityDate>2024-04-19T19:31:25.0189344+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>3570f6b1-9941-44bf-a5ff-203c990fe17d</transactionID> <updateDate>2024-04-19T19:31:25.0189344+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>82d9224b-bdf1-4dd2-a8f5-e58adc559fe1</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> </rewardConfirmation>