POST api/rewards/issue

Issue a specific reward.

Request Information

URI Parameters

Query String: overrideIneligible={overrideIneligible}

NameDescriptionTypeAdditional 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

NameDescriptionTypeAdditional 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

NameDescriptionTypeAdditional 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": "cd6f499b-6a59-45cf-b81b-c71cecefe9de",
    "payoutId": "ad568f4e-bedf-4088-b9de-fb360d9b3bc9",
    "payoutDescription": "sample string 3",
    "programId": "063a57b4-81bd-4ac0-b303-3b43fc7bf025",
    "programName": "sample string 5",
    "memberId": "c21848c5-47f9-4cdf-b083-5472ab4fab30",
    "referralId": "198c8ee4-859d-47dc-858b-a9c8356c83f8",
    "type": "sample string 6",
    "recipientId": "e7fcae62-9b5a-4dc9-bd03-aee81e9a4de7",
    "recipientName": "sample string 7",
    "recipientEmailAddress": "sample string 8",
    "status": "sample string 9",
    "amount": 10.0,
    "createDate": "2018-04-22T04:26:53.879278Z",
    "issueDate": "2018-04-22T04:26:53.879278Z",
    "eligibilityDate": "2018-04-22T04:26:53.879278Z",
    "description": "sample string 13"
  },
  "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>cd6f499b-6a59-45cf-b81b-c71cecefe9de</id>
    <payoutId>ad568f4e-bedf-4088-b9de-fb360d9b3bc9</payoutId>
    <payoutDescription>sample string 3</payoutDescription>
    <programId>063a57b4-81bd-4ac0-b303-3b43fc7bf025</programId>
    <programName>sample string 5</programName>
    <memberId>c21848c5-47f9-4cdf-b083-5472ab4fab30</memberId>
    <referralId>198c8ee4-859d-47dc-858b-a9c8356c83f8</referralId>
    <type>sample string 6</type>
    <recipientId>e7fcae62-9b5a-4dc9-bd03-aee81e9a4de7</recipientId>
    <recipientName>sample string 7</recipientName>
    <recipientEmailAddress>sample string 8</recipientEmailAddress>
    <status>sample string 9</status>
    <amount>10</amount>
    <createDate>2018-04-22T00:26:53.879278-04:00</createDate>
    <issueDate>2018-04-22T00:26:53.879278-04:00</issueDate>
    <eligibilityDate>2018-04-22T00:26:53.879278-04:00</eligibilityDate>
    <description>sample string 13</description>
  </reward>
</issueRewardResult>