POST api/rewards

Creates new rewards members and referrals of a referral program.

Request Information

URI Parameters

Query String:

None.

Body Parameters

A list of required structures containing the details about the reward to create.

Type: Collection of NewRewardInfo

Name	Description	Type	Additional information
memberQuery	A structure containing details to identify a member to reward.	MemberQuery	None.
referralQuery	A structure containing details to identify a referral to reward.	ReferralQuery	None.
newReward	Details about a reward to create. Required.	NewReward	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "memberQuery": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "referralQuery": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "newReward": {
      "amount": 1.0,
      "payoutId": "sample string 2",
      "eligibilityDate": "2025-01-18T03:50:22.2366292Z",
      "description": "sample string 3"
    }
  },
  {
    "memberQuery": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "referralQuery": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "newReward": {
      "amount": 1.0,
      "payoutId": "sample string 2",
      "eligibilityDate": "2025-01-18T03:50:22.2366292Z",
      "description": "sample string 3"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfnewRewardInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <newRewardInfo>
    <memberQuery>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </memberQuery>
    <referralQuery>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </referralQuery>
    <newReward>
      <payoutId>sample string 2</payoutId>
      <eligibilityDate>2025-01-18T03:50:22.2366292+00:00</eligibilityDate>
      <description>sample string 3</description>
      <amount>1</amount>
    </newReward>
  </newRewardInfo>
  <newRewardInfo>
    <memberQuery>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </memberQuery>
    <referralQuery>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </referralQuery>
    <newReward>
      <payoutId>sample string 2</payoutId>
      <eligibilityDate>2025-01-18T03:50:22.2366292+00:00</eligibilityDate>
      <description>sample string 3</description>
      <amount>1</amount>
    </newReward>
  </newRewardInfo>
</ArrayOfnewRewardInfo>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: Collection of NewRewardResult

Name	Description	Type	Additional information
memberQuery	Echos the member query sent in the request.	MemberQuery	None.
referralQuery	Echos the referral query sent in the request.	ReferralQuery	None.
reward	Details about a reward to created.	Reward	None.
resultInfo	Details about the results of the request.	ResultInfo	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "memberQuery": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "referralQuery": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "reward": {
      "id": "27127cfa-16eb-43ae-9d0e-f2974f78a368",
      "payoutId": "7f6200d3-170b-4ffb-8342-cfe121fc22f9",
      "payoutDescription": "sample string 3",
      "programId": "1c754b68-d398-4f21-a25e-4a7ef8b06fd0",
      "programName": "sample string 5",
      "memberId": "54d04cb9-fca0-4314-b1b7-c4be6c8110c2",
      "referralId": "30bf58a0-0e5d-437c-b14f-b1d1e6c93cbd",
      "type": "sample string 6",
      "recipientId": "15c95495-a707-432e-a10e-5ff8570120bf",
      "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-01-18T03:50:22.2522564Z",
      "issueDate": "2025-01-18T03:50:22.2522564Z",
      "eligibilityDate": "2025-01-18T03:50:22.2522564Z",
      "description": "sample string 15",
      "transactionID": "4b6f9f75-f865-4b75-8729-4f1da133fba6",
      "updateDate": "2025-01-18T03:50:22.2522564Z",
      "referralDisplayName": "sample string 17",
      "currencyCode": "sample string 18",
      "source": "sample string 19",
      "programRewardRuleId": "727be423-f086-4027-9b99-f8836d0b75aa",
      "paymentType": "sample string 20",
      "paymentCode": "sample string 21",
      "completeNote": "sample string 22"
    },
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  },
  {
    "memberQuery": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "referralQuery": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "reward": {
      "id": "27127cfa-16eb-43ae-9d0e-f2974f78a368",
      "payoutId": "7f6200d3-170b-4ffb-8342-cfe121fc22f9",
      "payoutDescription": "sample string 3",
      "programId": "1c754b68-d398-4f21-a25e-4a7ef8b06fd0",
      "programName": "sample string 5",
      "memberId": "54d04cb9-fca0-4314-b1b7-c4be6c8110c2",
      "referralId": "30bf58a0-0e5d-437c-b14f-b1d1e6c93cbd",
      "type": "sample string 6",
      "recipientId": "15c95495-a707-432e-a10e-5ff8570120bf",
      "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-01-18T03:50:22.2522564Z",
      "issueDate": "2025-01-18T03:50:22.2522564Z",
      "eligibilityDate": "2025-01-18T03:50:22.2522564Z",
      "description": "sample string 15",
      "transactionID": "4b6f9f75-f865-4b75-8729-4f1da133fba6",
      "updateDate": "2025-01-18T03:50:22.2522564Z",
      "referralDisplayName": "sample string 17",
      "currencyCode": "sample string 18",
      "source": "sample string 19",
      "programRewardRuleId": "727be423-f086-4027-9b99-f8836d0b75aa",
      "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:

<ArrayOfnewRewardResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <newRewardResult>
    <memberQuery>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </memberQuery>
    <referralQuery>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </referralQuery>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
    <reward>
      <id>27127cfa-16eb-43ae-9d0e-f2974f78a368</id>
      <payoutId>7f6200d3-170b-4ffb-8342-cfe121fc22f9</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>1c754b68-d398-4f21-a25e-4a7ef8b06fd0</programId>
      <programName>sample string 5</programName>
      <memberId>54d04cb9-fca0-4314-b1b7-c4be6c8110c2</memberId>
      <referralId>30bf58a0-0e5d-437c-b14f-b1d1e6c93cbd</referralId>
      <type>sample string 6</type>
      <recipientId>15c95495-a707-432e-a10e-5ff8570120bf</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-01-18T03:50:22.2522564+00:00</createDate>
      <issueDate>2025-01-18T03:50:22.2522564+00:00</issueDate>
      <eligibilityDate>2025-01-18T03:50:22.2522564+00:00</eligibilityDate>
      <description>sample string 15</description>
      <transactionID>4b6f9f75-f865-4b75-8729-4f1da133fba6</transactionID>
      <updateDate>2025-01-18T03:50:22.2522564+00:00</updateDate>
      <referralDisplayName>sample string 17</referralDisplayName>
      <currencyCode>sample string 18</currencyCode>
      <source>sample string 19</source>
      <programRewardRuleId>727be423-f086-4027-9b99-f8836d0b75aa</programRewardRuleId>
      <paymentType>sample string 20</paymentType>
      <paymentCode>sample string 21</paymentCode>
      <completeNote>sample string 22</completeNote>
    </reward>
  </newRewardResult>
  <newRewardResult>
    <memberQuery>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </memberQuery>
    <referralQuery>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </referralQuery>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
    <reward>
      <id>27127cfa-16eb-43ae-9d0e-f2974f78a368</id>
      <payoutId>7f6200d3-170b-4ffb-8342-cfe121fc22f9</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>1c754b68-d398-4f21-a25e-4a7ef8b06fd0</programId>
      <programName>sample string 5</programName>
      <memberId>54d04cb9-fca0-4314-b1b7-c4be6c8110c2</memberId>
      <referralId>30bf58a0-0e5d-437c-b14f-b1d1e6c93cbd</referralId>
      <type>sample string 6</type>
      <recipientId>15c95495-a707-432e-a10e-5ff8570120bf</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-01-18T03:50:22.2522564+00:00</createDate>
      <issueDate>2025-01-18T03:50:22.2522564+00:00</issueDate>
      <eligibilityDate>2025-01-18T03:50:22.2522564+00:00</eligibilityDate>
      <description>sample string 15</description>
      <transactionID>4b6f9f75-f865-4b75-8729-4f1da133fba6</transactionID>
      <updateDate>2025-01-18T03:50:22.2522564+00:00</updateDate>
      <referralDisplayName>sample string 17</referralDisplayName>
      <currencyCode>sample string 18</currencyCode>
      <source>sample string 19</source>
      <programRewardRuleId>727be423-f086-4027-9b99-f8836d0b75aa</programRewardRuleId>
      <paymentType>sample string 20</paymentType>
      <paymentCode>sample string 21</paymentCode>
      <completeNote>sample string 22</completeNote>
    </reward>
  </newRewardResult>
</ArrayOfnewRewardResult>