POST api/rewards/issue
Issue a specific reward.
Request Information
URI Parameters
Query String: overrideIneligible={overrideIneligible}
Name | Description | Type | Additional information |
---|---|---|---|
overrideIneligible |
Allows you to override eligiblity date rules. Issue rewards with eligibility dates in the future. Optional. |
boolean |
Default value is False |
Body Parameters
Data needed for issuing a reward. Required.
Type: IssueRewardInfo
Name | Description | Type | Additional information |
---|---|---|---|
rewardId |
The unique ID of the reward to issue. |
string |
Required |
recipientInfo |
(deprecated) Additional info about the reward to issue. In most cases, this can be left blank. For PayPal, include the email address of the recipient. Optional. |
string |
None. |
note |
A message to be sent to the recipient of the reward. Optional. |
string |
None. |
Request Formats
application/json, text/json
{ "rewardId": "sample string 1", "recipientInfo": "sample string 2", "note": "sample string 3" }
application/xml, text/xml
<issueReward xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <note>sample string 3</note> <recipientInfo>sample string 2</recipientInfo> <rewardId>sample string 1</rewardId> </issueReward>
Response Information
Resource Description
[HTTP Status 200 - OK]
Type: IssueRewardResult
Name | Description | Type | Additional information |
---|---|---|---|
reward |
The reward, after the attempt to issue it has been received. |
Reward |
None. |
resultInfo |
Details about the results of the request. |
ResultInfo |
None. |
Response Formats
application/json, text/json
{ "reward": { "id": "8d673008-72f8-4b12-94fd-d4f7a6b38077", "payoutId": "33a2e4b0-bada-4f89-b432-d28fc6c7b386", "payoutDescription": "sample string 3", "programId": "50d3b23d-6f37-40e6-bf3d-38105f2afcf2", "programName": "sample string 5", "memberId": "63ed8986-65ba-43fa-b9c1-f743bba6d9e5", "referralId": "7d0266ec-a9f9-4ef7-a91b-4f3dd50cf3e0", "type": "sample string 6", "recipientId": "f74ab79d-2efe-4870-9221-8107b453590f", "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-08-02T06:06:32.8168405Z", "issueDate": "2025-08-02T06:06:32.8168405Z", "eligibilityDate": "2025-08-02T06:06:32.8168405Z", "description": "sample string 15", "transactionID": "6565d4d3-975d-4cba-a2e4-d1bf23364dbc", "updateDate": "2025-08-02T06:06:32.8168405Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "b34b652a-d80c-4ef5-aaea-b9f7f74a3ddb", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22", "reason": "sample string 23", "reasonOther": "sample string 24" }, "resultInfo": { "Status": "sample string 1", "Message": "sample string 2" } }
application/xml, text/xml
<issueRewardResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <resultInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response"> <d2p1:Message>sample string 2</d2p1:Message> <d2p1:Status>sample string 1</d2p1:Status> </resultInfo> <reward> <id>8d673008-72f8-4b12-94fd-d4f7a6b38077</id> <payoutId>33a2e4b0-bada-4f89-b432-d28fc6c7b386</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>50d3b23d-6f37-40e6-bf3d-38105f2afcf2</programId> <programName>sample string 5</programName> <memberId>63ed8986-65ba-43fa-b9c1-f743bba6d9e5</memberId> <referralId>7d0266ec-a9f9-4ef7-a91b-4f3dd50cf3e0</referralId> <type>sample string 6</type> <recipientId>f74ab79d-2efe-4870-9221-8107b453590f</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-08-02T06:06:32.8168405+00:00</createDate> <issueDate>2025-08-02T06:06:32.8168405+00:00</issueDate> <eligibilityDate>2025-08-02T06:06:32.8168405+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>6565d4d3-975d-4cba-a2e4-d1bf23364dbc</transactionID> <updateDate>2025-08-02T06:06:32.8168405+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>b34b652a-d80c-4ef5-aaea-b9f7f74a3ddb</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> </issueRewardResult>