| Name | Description | Type | Additional information |
|---|---|---|---|
|
The customer's email address. Required. Used as the primary match key against pending referrals and existing members. |
string |
None. |
|
| externalId |
Your system's identifier for this customer (e.g. a Stripe customer id or CRM contact id). Stored on any matched referral for downstream reconciliation and echoed back on the result for caller-side correlation. Optional. |
string |
None. |
| firstName |
Customer first name. Written to referral demographics on match, or to the preloaded member profile. Optional. |
string |
None. |
| lastName |
Customer last name. Written to referral demographics on match, or to the preloaded member profile. Optional. |
string |
None. |
| phone |
Customer phone number. Free-form; no format enforcement. Optional. |
string |
None. |
| addressLine1 |
Customer street address. Optional. |
string |
None. |
| addressLine2 |
Customer street address line 2 (apartment, suite, etc.). Optional. |
string |
None. |
| city |
Customer city. Optional. |
string |
None. |
| region |
Customer region, a region name or ISO_3166-2 subdivision code. Optional. |
string |
None. |
| postalCode |
Customer postal code. Optional. |
string |
None. |
| amount |
Purchase amount associated with this customer. Feeds reward calculation when a matched referral is approved. Defaults to 0 if omitted. Optional. |
decimal number |
None. |
| purchaseDate |
Purchase date associated with this customer. Defaults to the server's current UTC time if omitted. Optional. |
date |
None. |