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
[ { "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": "2024-04-26T16:27:12.309045Z", "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": "2024-04-26T16:27:12.309045Z", "description": "sample string 3" } } ]
application/xml, text/xml
<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>2024-04-26T16:27:12.309045+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>2024-04-26T16:27:12.309045+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
[ { "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": "67836485-8f41-4761-b559-5f2bc323fee8", "payoutId": "46eb8580-20b4-47de-87a5-199057b72249", "payoutDescription": "sample string 3", "programId": "dc91491d-c2c1-4f9b-9647-79fdee1146dc", "programName": "sample string 5", "memberId": "49eb9657-1ebf-4e9d-bf53-ad33e04bff11", "referralId": "7490bf74-2cec-410d-a571-d83c8a064ca9", "type": "sample string 6", "recipientId": "542522df-3c6b-4f19-98b5-11a3c7d29761", "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-26T16:27:12.3402979Z", "issueDate": "2024-04-26T16:27:12.3402979Z", "eligibilityDate": "2024-04-26T16:27:12.3402979Z", "description": "sample string 15", "transactionID": "a28b8846-14fa-49df-88b9-07323d6e9d48", "updateDate": "2024-04-26T16:27:12.3402979Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "2cb03a5b-3972-449b-8195-dad4964ee398", "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": "67836485-8f41-4761-b559-5f2bc323fee8", "payoutId": "46eb8580-20b4-47de-87a5-199057b72249", "payoutDescription": "sample string 3", "programId": "dc91491d-c2c1-4f9b-9647-79fdee1146dc", "programName": "sample string 5", "memberId": "49eb9657-1ebf-4e9d-bf53-ad33e04bff11", "referralId": "7490bf74-2cec-410d-a571-d83c8a064ca9", "type": "sample string 6", "recipientId": "542522df-3c6b-4f19-98b5-11a3c7d29761", "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-26T16:27:12.3402979Z", "issueDate": "2024-04-26T16:27:12.3402979Z", "eligibilityDate": "2024-04-26T16:27:12.3402979Z", "description": "sample string 15", "transactionID": "a28b8846-14fa-49df-88b9-07323d6e9d48", "updateDate": "2024-04-26T16:27:12.3402979Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "2cb03a5b-3972-449b-8195-dad4964ee398", "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
<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>67836485-8f41-4761-b559-5f2bc323fee8</id> <payoutId>46eb8580-20b4-47de-87a5-199057b72249</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>dc91491d-c2c1-4f9b-9647-79fdee1146dc</programId> <programName>sample string 5</programName> <memberId>49eb9657-1ebf-4e9d-bf53-ad33e04bff11</memberId> <referralId>7490bf74-2cec-410d-a571-d83c8a064ca9</referralId> <type>sample string 6</type> <recipientId>542522df-3c6b-4f19-98b5-11a3c7d29761</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-26T16:27:12.3402979+00:00</createDate> <issueDate>2024-04-26T16:27:12.3402979+00:00</issueDate> <eligibilityDate>2024-04-26T16:27:12.3402979+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>a28b8846-14fa-49df-88b9-07323d6e9d48</transactionID> <updateDate>2024-04-26T16:27:12.3402979+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>2cb03a5b-3972-449b-8195-dad4964ee398</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>67836485-8f41-4761-b559-5f2bc323fee8</id> <payoutId>46eb8580-20b4-47de-87a5-199057b72249</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>dc91491d-c2c1-4f9b-9647-79fdee1146dc</programId> <programName>sample string 5</programName> <memberId>49eb9657-1ebf-4e9d-bf53-ad33e04bff11</memberId> <referralId>7490bf74-2cec-410d-a571-d83c8a064ca9</referralId> <type>sample string 6</type> <recipientId>542522df-3c6b-4f19-98b5-11a3c7d29761</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-26T16:27:12.3402979+00:00</createDate> <issueDate>2024-04-26T16:27:12.3402979+00:00</issueDate> <eligibilityDate>2024-04-26T16:27:12.3402979+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>a28b8846-14fa-49df-88b9-07323d6e9d48</transactionID> <updateDate>2024-04-26T16:27:12.3402979+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>2cb03a5b-3972-449b-8195-dad4964ee398</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> </newRewardResult> </ArrayOfnewRewardResult>