POST api/referralaction

Creates a new Referral Action to be used for processing new recurring rewards

Request Information

URI Parameters

Query String:

None.

Body Parameters

The details about Referral Action such as amount and Referral matching criteria.

Name	Description	Type	Additional information
amount	Referral action amount, used for calculating percentage based recurring rewards. Required.	decimal number	None.
referralQuery	Referral Query. Check by ReferralID, email address or External Id. Required.	string	Required
programQuery	Program Query. Search by ID of the program, program name, or program title. Optional.	string	None.
name	Referral action name. Optional.	string	None.
externalIdentifier	External ID, used for preventing duplicates and referencing original source. Optional.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "amount": 1.0,
  "referralQuery": "sample string 2",
  "programQuery": "sample string 3",
  "name": "sample string 4",
  "externalIdentifier": "sample string 5"
}

application/xml, text/xml

Sample:

<referralAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <amount>1</amount>
  <externalIdentifier>sample string 5</externalIdentifier>
  <name>sample string 4</name>
  <programQuery>sample string 3</programQuery>
  <referralQuery>sample string 2</referralQuery>
</referralAction>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.