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

Sample:

{
  "rewardId": "sample string 1",
  "recipientInfo": "sample string 2",
  "note": "sample string 3"
}

application/xml, text/xml

Sample:

<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

Sample:

{
  "reward": {
    "id": "6c7fd5f8-a059-433f-9c95-c4faa4058468",
    "payoutId": "82fcef1c-a091-408f-b5ac-4ab01ea94e6a",
    "payoutDescription": "sample string 3",
    "programId": "1688cabe-672e-42c4-ae06-6b35f169f646",
    "programName": "sample string 5",
    "memberId": "48c00901-3ecd-43fc-80f4-790544491512",
    "referralId": "7209e8b2-f8aa-4398-a411-5c4965f3271c",
    "type": "sample string 6",
    "recipientId": "de29872a-1939-4520-b602-23b83d6747cd",
    "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-04-19T12:54:16.4877579Z",
    "issueDate": "2025-04-19T12:54:16.4877579Z",
    "eligibilityDate": "2025-04-19T12:54:16.4877579Z",
    "description": "sample string 15",
    "transactionID": "b1e59169-e647-4d4d-932a-8519bcd3f3aa",
    "updateDate": "2025-04-19T12:54:16.4877579Z",
    "referralDisplayName": "sample string 17",
    "currencyCode": "sample string 18",
    "source": "sample string 19",
    "programRewardRuleId": "9fb1c78b-89aa-4254-9e03-939d296f8e72",
    "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

Sample:

<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>6c7fd5f8-a059-433f-9c95-c4faa4058468</id>
    <payoutId>82fcef1c-a091-408f-b5ac-4ab01ea94e6a</payoutId>
    <payoutDescription>sample string 3</payoutDescription>
    <programId>1688cabe-672e-42c4-ae06-6b35f169f646</programId>
    <programName>sample string 5</programName>
    <memberId>48c00901-3ecd-43fc-80f4-790544491512</memberId>
    <referralId>7209e8b2-f8aa-4398-a411-5c4965f3271c</referralId>
    <type>sample string 6</type>
    <recipientId>de29872a-1939-4520-b602-23b83d6747cd</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-04-19T12:54:16.4877579+00:00</createDate>
    <issueDate>2025-04-19T12:54:16.4877579+00:00</issueDate>
    <eligibilityDate>2025-04-19T12:54:16.4877579+00:00</eligibilityDate>
    <description>sample string 15</description>
    <transactionID>b1e59169-e647-4d4d-932a-8519bcd3f3aa</transactionID>
    <updateDate>2025-04-19T12:54:16.4877579+00:00</updateDate>
    <referralDisplayName>sample string 17</referralDisplayName>
    <currencyCode>sample string 18</currencyCode>
    <source>sample string 19</source>
    <programRewardRuleId>9fb1c78b-89aa-4254-9e03-939d296f8e72</programRewardRuleId>
    <paymentType>sample string 20</paymentType>
    <paymentCode>sample string 21</paymentCode>
    <completeNote>sample string 22</completeNote>
  </reward>
</issueRewardResult>