| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique ID of the referral. |
globally unique identifier |
None. |
| displayName |
Referral's Display Name |
string |
None. |
| firstName |
Referral first name |
string |
None. |
| lastName |
Referral last name |
string |
None. |
| fullName | string |
None. |
|
|
Referral email address |
string |
None. |
|
| externalIdentifier |
An alternative ID provided to help link the member to relevant data in external systems. |
string |
None. |
| phoneNumber | string |
None. |
|
| amount | decimal number |
None. |
|
| amountFormatted | string |
None. |
|
| preferredContact |
The preferred means to contact the referral. The values an be 'email', 'callMorning', 'callAfternoon', or 'callEvening'. |
string |
None. |
| createDate | date |
None. |
|
| updateDate | date |
None. |
|
| source | string |
None. |
|
| programId |
The unique ID of the referral program that the referral responded to. |
globally unique identifier |
None. |
| programName | string |
None. |
|
| programTitle | string |
None. |
|
| referringMemberId |
The unique ID of the member that made the referral. |
globally unique identifier |
None. |
| referringMemberName |
The name of the member that made the referral. |
string |
None. |
| memberEmail | string |
None. |
|
| memberReferralCode | string |
None. |
|
| memberExternalIdentifier | string |
None. |
|
| approvedDate | date |
None. |
|
| qualifiedDate | date |
None. |
|
| status |
The value can be "pending", "qualified", "approved", "denied". |
string |
None. |
| companyName | string |
None. |
|
| note | string |
None. |
|
| publicNote | string |
None. |
|
| customOption1Name | string |
None. |
|
| customOption2Name | string |
None. |
|
| customText1Name | string |
None. |
|
| customText2Name | string |
None. |
|
| customText3Name | string |
None. |
|
| customOption1Value | string |
None. |
|
| customOption2Value | string |
None. |
|
| customText1Value | string |
None. |
|
| customText2Value | string |
None. |
|
| customText3Value | string |
None. |
|
| conversionNote | string |
None. |
|
| conversionIPAddress | string |
None. |
|
| utmSource | string |
None. |
|
| utmMedium | string |
None. |
|
| utmCampaign | string |
None. |
|
| browserReferrerUrl | string |
None. |
|
| IPAddressSource | string |
None. |