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

Sample:

[
  {
    "rewardId": "sample string 1",
    "amount": 1.0,
    "payoutId": "sample string 2",
    "eligibilityDate": "2024-11-08T10:26:33.2282749Z",
    "description": "sample string 3"
  },
  {
    "rewardId": "sample string 1",
    "amount": 1.0,
    "payoutId": "sample string 2",
    "eligibilityDate": "2024-11-08T10:26:33.2282749Z",
    "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>2024-11-08T10:26:33.2282749+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-11-08T10:26:33.2282749+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

Sample:

{
  "message": "sample string 1",
  "reward": {
    "id": "3344d59a-7c5d-4215-b9e7-64decfd64324",
    "payoutId": "35b685c5-e237-4c5d-8f18-8eb6e4c98dc1",
    "payoutDescription": "sample string 3",
    "programId": "a68421c2-4d12-405a-8beb-2f066b47e76c",
    "programName": "sample string 5",
    "memberId": "a82d66ce-b2fd-4ff4-9520-4bc81f7a7f49",
    "referralId": "cf831a31-93c0-4b75-a7d6-f009b549deec",
    "type": "sample string 6",
    "recipientId": "3b63087c-acda-4e9b-9f93-968832a1a1b8",
    "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-11-08T10:26:33.2439072Z",
    "issueDate": "2024-11-08T10:26:33.2439072Z",
    "eligibilityDate": "2024-11-08T10:26:33.2439072Z",
    "description": "sample string 15",
    "transactionID": "7baa10aa-b665-412d-b181-82dc3d5894ee",
    "updateDate": "2024-11-08T10:26:33.2439072Z",
    "referralDisplayName": "sample string 17",
    "currencyCode": "sample string 18",
    "source": "sample string 19",
    "programRewardRuleId": "6c41a4f7-77b0-4ce9-8ff5-266394b15c7c",
    "paymentType": "sample string 20",
    "paymentCode": "sample string 21",
    "completeNote": "sample string 22"
  }
}

application/xml, text/xml

Sample:

<rewardConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <reward>
    <id>3344d59a-7c5d-4215-b9e7-64decfd64324</id>
    <payoutId>35b685c5-e237-4c5d-8f18-8eb6e4c98dc1</payoutId>
    <payoutDescription>sample string 3</payoutDescription>
    <programId>a68421c2-4d12-405a-8beb-2f066b47e76c</programId>
    <programName>sample string 5</programName>
    <memberId>a82d66ce-b2fd-4ff4-9520-4bc81f7a7f49</memberId>
    <referralId>cf831a31-93c0-4b75-a7d6-f009b549deec</referralId>
    <type>sample string 6</type>
    <recipientId>3b63087c-acda-4e9b-9f93-968832a1a1b8</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-11-08T10:26:33.2439072+00:00</createDate>
    <issueDate>2024-11-08T10:26:33.2439072+00:00</issueDate>
    <eligibilityDate>2024-11-08T10:26:33.2439072+00:00</eligibilityDate>
    <description>sample string 15</description>
    <transactionID>7baa10aa-b665-412d-b181-82dc3d5894ee</transactionID>
    <updateDate>2024-11-08T10:26:33.2439072+00:00</updateDate>
    <referralDisplayName>sample string 17</referralDisplayName>
    <currencyCode>sample string 18</currencyCode>
    <source>sample string 19</source>
    <programRewardRuleId>6c41a4f7-77b0-4ce9-8ff5-266394b15c7c</programRewardRuleId>
    <paymentType>sample string 20</paymentType>
    <paymentCode>sample string 21</paymentCode>
    <completeNote>sample string 22</completeNote>
  </reward>
</rewardConfirmation>