POST api/referrals

Adds referral to a referral program based on a referral code from a member.

Request Information

URI Parameters

Query String:

None.

Body Parameters

Type: NewReferral

NameDescriptionTypeAdditional information
referralCode

The referral code from the member that introduced the referral.

 string

Required
firstName

Referral first name. Optional

 string

None.
lastName

Referral last name. Optional

 string

None.
email

Referral email address. Optional

 string

None.
phoneNumber

Customer’s phone number. Optional

 string

None.
preferredContact

The preferred means to contact the referral. The values an be 'email', 'callMorning', 'callAfternoon', or 'callEvening'. Optional.

 string

None.
externalIdentifier

Unique external identifier you can use to later reference the referral. (i.e. another system's unique identifier, like a order number or customer ID). Optional.

 string

None.
amount

Passed order amount/total. Optional.

 decimal number

None.
companyName

Company name. Optional.

 string

None.
note

Any note or other information you want to see tied to the Referral. Optional.

 string

None.
publicNote

Any note that you want to be publicly tied to the Referral. Optional.

 string

None.
customOption1Name

Custom option 1 name. Optional.

 string

None.
customOption2Name

Custom option 2 name. Optional.

 string

None.
customText1Name

Custom option 2 name. Optional.

 string

None.
customText2Name

Custom text 2 name. Optional.

 string

None.
customText3Name

Custom text 3 name. Optional.

 string

None.
customOption1Value

Custom value tied to customoption1name. Optional.

 string

None.
customOption2Value

Custom value tied to customoption2name. Optional.

 string

None.
customText1Value

Custom value tied to customtext1name. Optional.

 string

None.
customText2Value

Custom value tied to customtext2name. Optional.

 string

None.
customText3Value

Custom value tied to customtext3name. Optional.

 string

None.
status

Status of the Referral. The value can be "pending", "qualified", "approved", "denied". Optional.

 string

None.
addressLine1

Referral address line 1. Optional.

 string

None.
addressLine2

Referral address line 2. Optional.

 string

None.
city

Referral city name. Optional.

 string

None.
region

Referral region, must be a region name or ISO_3166-2 subdivision code, can only be supplied if country is also provided. Optional.

 string

None.
postalCode

Referral postal code. Optional.

 string

None.
country

Referral country name or ISO_3166-2 country code. Optional.

 string

None.
recruiterAssignedId

RecruiterId currently assigned to the referral. Optional.

 globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "referralCode": "sample string 1",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "email": "sample string 4",
  "phoneNumber": "sample string 5",
  "preferredContact": "sample string 6",
  "externalIdentifier": "sample string 7",
  "amount": 1.0,
  "companyName": "sample string 8",
  "note": "sample string 9",
  "publicNote": "sample string 10",
  "customOption1Name": "sample string 11",
  "customOption2Name": "sample string 12",
  "customText1Name": "sample string 13",
  "customText2Name": "sample string 14",
  "customText3Name": "sample string 15",
  "customOption1Value": "sample string 16",
  "customOption2Value": "sample string 17",
  "customText1Value": "sample string 18",
  "customText2Value": "sample string 19",
  "customText3Value": "sample string 20",
  "status": "sample string 21",
  "addressLine1": "sample string 22",
  "addressLine2": "sample string 23",
  "city": "sample string 24",
  "region": "sample string 25",
  "postalCode": "sample string 26",
  "country": "sample string 27",
  "recruiterAssignedId": "e1a55127-5f40-4235-abd1-6b1412756332"
}

application/xml, text/xml

Sample: 
<newReferral xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <firstName>sample string 2</firstName>
  <lastName>sample string 3</lastName>
  <email>sample string 4</email>
  <phoneNumber>sample string 5</phoneNumber>
  <preferredContact>sample string 6</preferredContact>
  <externalIdentifier>sample string 7</externalIdentifier>
  <amount>1</amount>
  <companyName>sample string 8</companyName>
  <note>sample string 9</note>
  <publicNote>sample string 10</publicNote>
  <customOption1Name>sample string 11</customOption1Name>
  <customOption2Name>sample string 12</customOption2Name>
  <customText1Name>sample string 13</customText1Name>
  <customText2Name>sample string 14</customText2Name>
  <customText3Name>sample string 15</customText3Name>
  <customOption1Value>sample string 16</customOption1Value>
  <customOption2Value>sample string 17</customOption2Value>
  <customText1Value>sample string 18</customText1Value>
  <customText2Value>sample string 19</customText2Value>
  <customText3Value>sample string 20</customText3Value>
  <status>sample string 21</status>
  <addressLine1>sample string 22</addressLine1>
  <addressLine2>sample string 23</addressLine2>
  <city>sample string 24</city>
  <region>sample string 25</region>
  <postalCode>sample string 26</postalCode>
  <country>sample string 27</country>
  <recruiterAssignedId>e1a55127-5f40-4235-abd1-6b1412756332</recruiterAssignedId>
  <referralCode>sample string 1</referralCode>
</newReferral>

Response Information

Resource Description

[HTTP Status 201 - Created]

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": "77e533fa-2645-465a-84f2-e532079daf8b",
    "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": "2025-10-17T17:30:28.9137317Z",
    "updateDate": "2025-10-17T17:30:28.9137317Z",
    "source": "sample string 14",
    "programId": "95bf901e-f678-4bd1-a6ec-7ff5c2070702",
    "programName": "sample string 16",
    "programTitle": "sample string 17",
    "referringMemberId": "f00e84ad-3f46-4104-924a-8db4687ecb14",
    "referringMemberName": "sample string 19",
    "memberEmail": "sample string 20",
    "memberReferralCode": "sample string 21",
    "memberExternalIdentifier": "sample string 22",
    "approvedDate": "2025-10-17T17:30:28.9137317Z",
    "qualifiedDate": "2025-10-17T17:30:28.9137317Z",
    "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",
    "addressLine1": "sample string 44",
    "addressLine2": "sample string 45",
    "city": "sample string 46",
    "region": "sample string 47",
    "postalCode": "sample string 48",
    "country": "sample string 49",
    "recruiterSourceId": "aa337a27-e4b1-45a5-b8d2-9917c5b255fa",
    "recruiterSourceName": "sample string 50",
    "recruiterSourceEmail": "sample string 51",
    "recruiterAssignedId": "74201538-d376-4096-b35f-43a1b8bc1655",
    "recruiterAssignedName": "sample string 52",
    "recruiterAssignedEmail": "sample string 53"
  }
}

application/xml, text/xml

Sample: 
<referralConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <referral>
    <id>77e533fa-2645-465a-84f2-e532079daf8b</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>2025-10-17T17:30:28.9137317+00:00</createDate>
    <preferredContact>sample string 11</preferredContact>
    <updateDate>2025-10-17T17:30:28.9137317+00:00</updateDate>
    <source>sample string 14</source>
    <programId>95bf901e-f678-4bd1-a6ec-7ff5c2070702</programId>
    <programName>sample string 16</programName>
    <programTitle>sample string 17</programTitle>
    <referringMemberId>f00e84ad-3f46-4104-924a-8db4687ecb14</referringMemberId>
    <referringMemberName>sample string 19</referringMemberName>
    <memberEmail>sample string 20</memberEmail>
    <memberReferralCode>sample string 21</memberReferralCode>
    <memberExternalIdentifier>sample string 22</memberExternalIdentifier>
    <approvedDate>2025-10-17T17:30:28.9137317+00:00</approvedDate>
    <qualifiedDate>2025-10-17T17:30:28.9137317+00: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>
    <addressLine1>sample string 44</addressLine1>
    <addressLine2>sample string 45</addressLine2>
    <city>sample string 46</city>
    <region>sample string 47</region>
    <postalCode>sample string 48</postalCode>
    <country>sample string 49</country>
    <recruiterSourceId>aa337a27-e4b1-45a5-b8d2-9917c5b255fa</recruiterSourceId>
    <recruiterSourceName>sample string 50</recruiterSourceName>
    <recruiterSourceEmail>sample string 51</recruiterSourceEmail>
    <recruiterAssignedId>74201538-d376-4096-b35f-43a1b8bc1655</recruiterAssignedId>
    <recruiterAssignedName>sample string 52</recruiterAssignedName>
    <recruiterAssignedEmail>sample string 53</recruiterAssignedEmail>
  </referral>
</referralConfirmation>