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": "2025-09-11T23:23:17.5972423Z", "description": "sample string 3" }, { "rewardId": "sample string 1", "amount": 1.0, "payoutId": "sample string 2", "eligibilityDate": "2025-09-11T23:23:17.5972423Z", "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>2025-09-11T23:23:17.5972423+00:00</eligibilityDate> <description>sample string 3</description> <rewardId>sample string 1</rewardId> <amount>1</amount> </updateReward> <updateReward> <payoutId>sample string 2</payoutId> <eligibilityDate>2025-09-11T23:23:17.5972423+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": "763204f0-cc99-4b08-a777-6055162fa7a4", "payoutId": "6c1e4dca-d0f9-44de-9c9e-1757ee602cb7", "payoutDescription": "sample string 3", "programId": "e9750a96-0a95-4104-9c6d-f134b16ed819", "programName": "sample string 5", "memberId": "87963c4d-6722-46ac-8524-6e7f84620624", "referralId": "d9cc3a81-bbe2-4c91-8104-42cfc09b2e92", "type": "sample string 6", "recipientId": "740460be-38b8-448e-9d82-4b87167db47a", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "recipientExternalIdentifier": "sample string 9", "externalIdentifier": "sample string 10", "status": "sample string 11", "amount": 12.0, "createDate": "2025-09-11T23:23:17.6127987Z", "issueDate": "2025-09-11T23:23:17.6127987Z", "eligibilityDate": "2025-09-11T23:23:17.6127987Z", "description": "sample string 15", "transactionID": "6606ccf7-9650-41f4-8613-41eebe5be4a5", "updateDate": "2025-09-11T23:23:17.6127987Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "0134157b-0662-46bb-a9e8-677ca80b63b9", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22", "reason": "sample string 23", "reasonOther": "sample string 24" } }
application/xml, text/xml
<rewardConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <message>sample string 1</message> <reward> <id>763204f0-cc99-4b08-a777-6055162fa7a4</id> <payoutId>6c1e4dca-d0f9-44de-9c9e-1757ee602cb7</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>e9750a96-0a95-4104-9c6d-f134b16ed819</programId> <programName>sample string 5</programName> <memberId>87963c4d-6722-46ac-8524-6e7f84620624</memberId> <referralId>d9cc3a81-bbe2-4c91-8104-42cfc09b2e92</referralId> <type>sample string 6</type> <recipientId>740460be-38b8-448e-9d82-4b87167db47a</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>2025-09-11T23:23:17.6127987+00:00</createDate> <issueDate>2025-09-11T23:23:17.6127987+00:00</issueDate> <eligibilityDate>2025-09-11T23:23:17.6127987+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>6606ccf7-9650-41f4-8613-41eebe5be4a5</transactionID> <updateDate>2025-09-11T23:23:17.6127987+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>0134157b-0662-46bb-a9e8-677ca80b63b9</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> <reason>sample string 23</reason> <reasonOther>sample string 24</reasonOther> </reward> </rewardConfirmation>