| Name | Description | Type | Additional information |
|---|---|---|---|
| programId |
The ID of the referral program to which the member will be added. |
string |
Required |
| recruiterSourceId |
RecruiterId assoicated with the member. Optional unless recruiterAssignedId is supplied. |
globally unique identifier |
None. |
| firstName | string |
Required |
|
| lastName |
Optional |
string |
None. |
| string |
Required |
||
| referralCode |
Optional |
string |
None. |
| phone |
Phone |
string |
None. |
| externalIdentifier |
An alternative ID provided to help link the member to relevant data in external systems. Optional. |
string |
None. |
| dateOfBirth |
Optional |
date |
None. |
| addressLine1 |
Optional |
string |
None. |
| addressLine2 |
Optional |
string |
None. |
| city |
Optional |
string |
None. |
| region |
Member region, must be a region name or ISO_3166-2 subdivision code, can only be supplied if country is also provided. Optional. |
string |
None. |
| countrySubdivision |
Member state/province Optional. New integrations must use region field instead. |
string |
None. |
| country |
Member country name or ISO_3166-2 country code. Optional. |
string |
None. |
| postalCode |
Optional. |
string |
None. |
| password |
Optional |
string |
None. |
| disabledFlag |
This flag is set if the member is NOT enabled for use in referral programs. Optional. |
boolean |
None. |
| payoutInfo |
Optional. |
MemberPayoutInfo |
None. |
| customOption1Name |
Custom Option 1 Name. Optional. |
string |
None. |
| customOption1Value |
Custom Option 1 Value. Optional. |
string |
None. |
| customText1Name |
Custom Text 1 Name. Optional. |
string |
None. |
| customText1Value |
Custom Text 1 Value. Optional. |
string |
None. |
| customText2Name |
Custom Text 2 Name. Optional. |
string |
None. |
| customText2Value |
Custom Text 2 Value. Optional. |
string |
None. |
| customOverrideURL |
Custom Override URL. Optional. |
string |
None. |
| recruiterAssignedId |
RecruiterId currently assigned to the member. Optional. |
globally unique identifier |
None. |