POST api/referrals/status

Updates the status of a referral. ("Going to be deprecated" please use POST api/referral/update).

Request Information

URI Parameters

Query String:

None.

Body Parameters

A list of required structures containing the referral information and new status.

Type: ReferralStatus

NameDescriptionTypeAdditional information
referralId

ID of the referral.

string

Required

programId

ID of the program that the referral belongs to. Optional.

string

None.

status

The value can be "pending", "qualified", "approved", "denied".

string

Required

amount

Amount. Optional.

decimal number

None.

publicNote

Public Note. Optional.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "referralId": "sample string 1",
  "programId": "sample string 2",
  "status": "sample string 3",
  "amount": 1.0,
  "publicNote": "sample string 4"
}

application/xml, text/xml

Sample:
<referralStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <amount>1</amount>
  <programId>sample string 2</programId>
  <publicNote>sample string 4</publicNote>
  <referralId>sample string 1</referralId>
  <status>sample string 3</status>
</referralStatus>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: ReferralConfirmation

NameDescriptionTypeAdditional information
referral

Structure containing details about the referral.

Referral

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "referral": {
    "id": "7ae4977e-5cb9-4626-aea1-db75fad6c920",
    "displayName": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "fullName": "sample string 5",
    "email": "sample string 6",
    "externalIdentifier": "sample string 7",
    "phoneNumber": "sample string 8",
    "amount": 9.0,
    "amountFormatted": "sample string 10",
    "preferredContact": "sample string 11",
    "createDate": "2018-07-19T13:34:03.3075014Z",
    "updateDate": "2018-07-19T13:34:03.3075014Z",
    "source": "sample string 14",
    "programId": "2adf6718-e398-4a43-b5ce-a8c3cf14ef48",
    "programName": "sample string 16",
    "programTitle": "sample string 17",
    "referringMemberId": "d52a38a3-f89d-4478-b080-92078a5f7a6e",
    "referringMemberName": "sample string 19",
    "memberEmail": "sample string 20",
    "memberReferralCode": "sample string 21",
    "memberExternalIdentifier": "sample string 22",
    "approvedDate": "2018-07-19T13:34:03.3075014Z",
    "qualifiedDate": "2018-07-19T13:34:03.3075014Z",
    "status": "sample string 23",
    "companyName": "sample string 24",
    "note": "sample string 25",
    "publicNote": "sample string 26",
    "customOption1Name": "sample string 27",
    "customOption2Name": "sample string 28",
    "customText1Name": "sample string 29",
    "customText2Name": "sample string 30",
    "customText3Name": "sample string 31",
    "customOption1Value": "sample string 32",
    "customOption2Value": "sample string 33",
    "customText1Value": "sample string 34",
    "customText2Value": "sample string 35",
    "customText3Value": "sample string 36",
    "conversionNote": "sample string 37",
    "conversionIPAddress": "sample string 38",
    "utmSource": "sample string 39",
    "utmMedium": "sample string 40",
    "utmCampaign": "sample string 41",
    "browserReferrerUrl": "sample string 42",
    "IPAddressSource": "sample string 43"
  }
}

application/xml, text/xml

Sample:
<referralConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <referral>
    <id>7ae4977e-5cb9-4626-aea1-db75fad6c920</id>
    <displayName>sample string 2</displayName>
    <firstName>sample string 3</firstName>
    <lastName>sample string 4</lastName>
    <fullName>sample string 5</fullName>
    <email>sample string 6</email>
    <externalIdentifier>sample string 7</externalIdentifier>
    <phoneNumber>sample string 8</phoneNumber>
    <amount>9</amount>
    <amountFormatted>sample string 10</amountFormatted>
    <createDate>2018-07-19T09:34:03.3075014-04:00</createDate>
    <preferredContact>sample string 11</preferredContact>
    <updateDate>2018-07-19T09:34:03.3075014-04:00</updateDate>
    <source>sample string 14</source>
    <programId>2adf6718-e398-4a43-b5ce-a8c3cf14ef48</programId>
    <programName>sample string 16</programName>
    <programTitle>sample string 17</programTitle>
    <referringMemberId>d52a38a3-f89d-4478-b080-92078a5f7a6e</referringMemberId>
    <referringMemberName>sample string 19</referringMemberName>
    <memberEmail>sample string 20</memberEmail>
    <memberReferralCode>sample string 21</memberReferralCode>
    <memberExternalIdentifier>sample string 22</memberExternalIdentifier>
    <approvedDate>2018-07-19T09:34:03.3075014-04:00</approvedDate>
    <qualifiedDate>2018-07-19T09:34:03.3075014-04:00</qualifiedDate>
    <status>sample string 23</status>
    <companyName>sample string 24</companyName>
    <note>sample string 25</note>
    <publicNote>sample string 26</publicNote>
    <customOption1Name>sample string 27</customOption1Name>
    <customOption2Name>sample string 28</customOption2Name>
    <customText1Name>sample string 29</customText1Name>
    <customText2Name>sample string 30</customText2Name>
    <customText3Name>sample string 31</customText3Name>
    <customOption1Value>sample string 32</customOption1Value>
    <customOption2Value>sample string 33</customOption2Value>
    <customText1Value>sample string 34</customText1Value>
    <customText2Value>sample string 35</customText2Value>
    <customText3Value>sample string 36</customText3Value>
    <conversionNote>sample string 37</conversionNote>
    <conversionIPAddress>sample string 38</conversionIPAddress>
    <utmSource>sample string 39</utmSource>
    <utmMedium>sample string 40</utmMedium>
    <utmCampaign>sample string 41</utmCampaign>
    <browserReferrerUrl>sample string 42</browserReferrerUrl>
    <IPAddressSource>sample string 43</IPAddressSource>
  </referral>
</referralConfirmation>