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

NameDescriptionTypeAdditional 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": "2018-07-19T13:40:29.3194907Z",
      "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": "2018-07-19T13:40:29.3194907Z",
      "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>2018-07-19T09:40:29.3194907-04: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>2018-07-19T09:40:29.3194907-04: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

NameDescriptionTypeAdditional 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": "19ed6626-c8b8-4097-bdea-9a866c7093b3",
      "payoutId": "98f0a87f-b777-441b-9c93-32342e588db8",
      "payoutDescription": "sample string 3",
      "programId": "65d2aa80-9c72-4e3e-af1c-365a7421cc9e",
      "programName": "sample string 5",
      "memberId": "6512516a-6f86-471b-922d-713ed36312fe",
      "referralId": "275b5e5e-94f2-40f6-b4f6-a857e1a87df7",
      "type": "sample string 6",
      "recipientId": "5c33bcef-5193-4440-b5fb-dae074c2eca7",
      "recipientName": "sample string 7",
      "recipientEmailAddress": "sample string 8",
      "status": "sample string 9",
      "amount": 10.0,
      "createDate": "2018-07-19T13:40:29.320486Z",
      "issueDate": "2018-07-19T13:40:29.320486Z",
      "eligibilityDate": "2018-07-19T13:40:29.320486Z",
      "description": "sample string 13",
      "transactionID": "65d7aa11-ab6c-4407-ac1a-32c8113c8598",
      "updateDate": "2018-07-19T13:40:29.320486Z",
      "referralDisplayName": "sample string 15"
    },
    "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": "19ed6626-c8b8-4097-bdea-9a866c7093b3",
      "payoutId": "98f0a87f-b777-441b-9c93-32342e588db8",
      "payoutDescription": "sample string 3",
      "programId": "65d2aa80-9c72-4e3e-af1c-365a7421cc9e",
      "programName": "sample string 5",
      "memberId": "6512516a-6f86-471b-922d-713ed36312fe",
      "referralId": "275b5e5e-94f2-40f6-b4f6-a857e1a87df7",
      "type": "sample string 6",
      "recipientId": "5c33bcef-5193-4440-b5fb-dae074c2eca7",
      "recipientName": "sample string 7",
      "recipientEmailAddress": "sample string 8",
      "status": "sample string 9",
      "amount": 10.0,
      "createDate": "2018-07-19T13:40:29.320486Z",
      "issueDate": "2018-07-19T13:40:29.320486Z",
      "eligibilityDate": "2018-07-19T13:40:29.320486Z",
      "description": "sample string 13",
      "transactionID": "65d7aa11-ab6c-4407-ac1a-32c8113c8598",
      "updateDate": "2018-07-19T13:40:29.320486Z",
      "referralDisplayName": "sample string 15"
    },
    "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>19ed6626-c8b8-4097-bdea-9a866c7093b3</id>
      <payoutId>98f0a87f-b777-441b-9c93-32342e588db8</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>65d2aa80-9c72-4e3e-af1c-365a7421cc9e</programId>
      <programName>sample string 5</programName>
      <memberId>6512516a-6f86-471b-922d-713ed36312fe</memberId>
      <referralId>275b5e5e-94f2-40f6-b4f6-a857e1a87df7</referralId>
      <type>sample string 6</type>
      <recipientId>5c33bcef-5193-4440-b5fb-dae074c2eca7</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientEmailAddress>sample string 8</recipientEmailAddress>
      <status>sample string 9</status>
      <amount>10</amount>
      <createDate>2018-07-19T09:40:29.320486-04:00</createDate>
      <issueDate>2018-07-19T09:40:29.320486-04:00</issueDate>
      <eligibilityDate>2018-07-19T09:40:29.320486-04:00</eligibilityDate>
      <description>sample string 13</description>
      <transactionID>65d7aa11-ab6c-4407-ac1a-32c8113c8598</transactionID>
      <updateDate>2018-07-19T09:40:29.320486-04:00</updateDate>
      <referralDisplayName>sample string 15</referralDisplayName>
    </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>19ed6626-c8b8-4097-bdea-9a866c7093b3</id>
      <payoutId>98f0a87f-b777-441b-9c93-32342e588db8</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>65d2aa80-9c72-4e3e-af1c-365a7421cc9e</programId>
      <programName>sample string 5</programName>
      <memberId>6512516a-6f86-471b-922d-713ed36312fe</memberId>
      <referralId>275b5e5e-94f2-40f6-b4f6-a857e1a87df7</referralId>
      <type>sample string 6</type>
      <recipientId>5c33bcef-5193-4440-b5fb-dae074c2eca7</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientEmailAddress>sample string 8</recipientEmailAddress>
      <status>sample string 9</status>
      <amount>10</amount>
      <createDate>2018-07-19T09:40:29.320486-04:00</createDate>
      <issueDate>2018-07-19T09:40:29.320486-04:00</issueDate>
      <eligibilityDate>2018-07-19T09:40:29.320486-04:00</eligibilityDate>
      <description>sample string 13</description>
      <transactionID>65d7aa11-ab6c-4407-ac1a-32c8113c8598</transactionID>
      <updateDate>2018-07-19T09:40:29.320486-04:00</updateDate>
      <referralDisplayName>sample string 15</referralDisplayName>
    </reward>
  </newRewardResult>
</ArrayOfnewRewardResult>