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": "2d9598fc-0338-426f-9bb3-ee928aa49d68", "payoutId": "cf2e7160-3d67-41d5-a633-cd074dbdef5a", "payoutDescription": "sample string 3", "programId": "8193a274-8790-4e6a-abc2-4ffca2c87d41", "programName": "sample string 5", "memberId": "87a5a325-ac38-4fa6-b140-c3295204f6ed", "referralId": "05958afb-9f4f-40a2-8571-84317ffb74fa", "type": "sample string 6", "recipientId": "cf7a9c27-935f-4779-97f6-b7c7ba6813a5", "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-06-27T10:20:59.2266154Z", "issueDate": "2025-06-27T10:20:59.2266154Z", "eligibilityDate": "2025-06-27T10:20:59.2266154Z", "description": "sample string 15", "transactionID": "f9d10d00-0844-407f-8368-0e4263476bb8", "updateDate": "2025-06-27T10:20:59.2266154Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "668bf49b-b6eb-4a2a-a9bd-bf6b72780bca", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22" }, "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>2d9598fc-0338-426f-9bb3-ee928aa49d68</id> <payoutId>cf2e7160-3d67-41d5-a633-cd074dbdef5a</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>8193a274-8790-4e6a-abc2-4ffca2c87d41</programId> <programName>sample string 5</programName> <memberId>87a5a325-ac38-4fa6-b140-c3295204f6ed</memberId> <referralId>05958afb-9f4f-40a2-8571-84317ffb74fa</referralId> <type>sample string 6</type> <recipientId>cf7a9c27-935f-4779-97f6-b7c7ba6813a5</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-06-27T10:20:59.2266154+00:00</createDate> <issueDate>2025-06-27T10:20:59.2266154+00:00</issueDate> <eligibilityDate>2025-06-27T10:20:59.2266154+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>f9d10d00-0844-407f-8368-0e4263476bb8</transactionID> <updateDate>2025-06-27T10:20:59.2266154+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>668bf49b-b6eb-4a2a-a9bd-bf6b72780bca</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> </issueRewardResult>