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": "fad7c7a7-5db2-470b-a6e3-ac170ffdbe28", "payoutId": "3d2dd2f9-0824-4fb4-a40a-027058883e39", "payoutDescription": "sample string 3", "programId": "725c8c99-4517-442a-a413-c62123376b01", "programName": "sample string 5", "memberId": "9fa43b3c-0425-433f-911b-8f79ee41aaf8", "referralId": "3e87ca43-1399-43fa-9d53-76456b8bccc0", "type": "sample string 6", "recipientId": "e75b44b6-24b3-4051-9172-4598175308ac", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "status": "sample string 9", "amount": 10.0, "createDate": "2022-07-02T05:28:22.5557376Z", "issueDate": "2022-07-02T05:28:22.5557376Z", "eligibilityDate": "2022-07-02T05:28:22.5557376Z", "description": "sample string 13", "transactionID": "845c3a95-ed5b-47d7-a2a2-0b0dc547354b", "updateDate": "2022-07-02T05:28:22.5557376Z", "referralDisplayName": "sample string 15", "currencyCode": "sample string 16" }, "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>fad7c7a7-5db2-470b-a6e3-ac170ffdbe28</id> <payoutId>3d2dd2f9-0824-4fb4-a40a-027058883e39</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>725c8c99-4517-442a-a413-c62123376b01</programId> <programName>sample string 5</programName> <memberId>9fa43b3c-0425-433f-911b-8f79ee41aaf8</memberId> <referralId>3e87ca43-1399-43fa-9d53-76456b8bccc0</referralId> <type>sample string 6</type> <recipientId>e75b44b6-24b3-4051-9172-4598175308ac</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <status>sample string 9</status> <amount>10</amount> <createDate>2022-07-02T05:28:22.5557376+00:00</createDate> <issueDate>2022-07-02T05:28:22.5557376+00:00</issueDate> <eligibilityDate>2022-07-02T05:28:22.5557376+00:00</eligibilityDate> <description>sample string 13</description> <transactionID>845c3a95-ed5b-47d7-a2a2-0b0dc547354b</transactionID> <updateDate>2022-07-02T05:28:22.5557376+00:00</updateDate> <referralDisplayName>sample string 15</referralDisplayName> <currencyCode>sample string 16</currencyCode> </reward> </issueRewardResult>