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": "6664844f-31bd-4984-90ba-bdfdc4631922", "payoutId": "b52e812d-b46b-44ea-b47e-debcf138d7b3", "payoutDescription": "sample string 3", "programId": "e66e5736-dad9-4d43-834f-d22423a954c1", "programName": "sample string 5", "memberId": "7aa8c451-97d3-4164-82d8-547d0f39ab06", "referralId": "e4826c0a-b03a-4d0c-bd74-3fdb9d8f99e3", "type": "sample string 6", "recipientId": "9242df50-bf71-4e9e-b1d7-e546489e8149", "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-04-27T02:40:05.734539Z", "issueDate": "2024-04-27T02:40:05.734539Z", "eligibilityDate": "2024-04-27T02:40:05.734539Z", "description": "sample string 15", "transactionID": "04f28121-94a6-457c-b8e6-cc8f101b267a", "updateDate": "2024-04-27T02:40:05.734539Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "4979b8b3-dd3f-4fa3-8823-89e76f455276", "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>6664844f-31bd-4984-90ba-bdfdc4631922</id> <payoutId>b52e812d-b46b-44ea-b47e-debcf138d7b3</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>e66e5736-dad9-4d43-834f-d22423a954c1</programId> <programName>sample string 5</programName> <memberId>7aa8c451-97d3-4164-82d8-547d0f39ab06</memberId> <referralId>e4826c0a-b03a-4d0c-bd74-3fdb9d8f99e3</referralId> <type>sample string 6</type> <recipientId>9242df50-bf71-4e9e-b1d7-e546489e8149</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-04-27T02:40:05.734539+00:00</createDate> <issueDate>2024-04-27T02:40:05.734539+00:00</issueDate> <eligibilityDate>2024-04-27T02:40:05.734539+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>04f28121-94a6-457c-b8e6-cc8f101b267a</transactionID> <updateDate>2024-04-27T02:40:05.734539+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>4979b8b3-dd3f-4fa3-8823-89e76f455276</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> </issueRewardResult>