customer
The customer object represents a ReKonect member's identifier. It is used to recognize and authenticate members across different API calls.
When to Use
Use the customer object whenever you need to identify a specific member using one or more supported identifiers such as phone number, email, or membership key.
This object is commonly used in API calls such as:
getMemberDetailsregisterMemberupdateMembersendShortCodesubmitTransactionexternalEvent
Supported Identifiers
| Field | Type | Description |
|---|---|---|
phoneNumber | string | Member's phone number (e.g., "530229344") |
email | string | Member's email address |
membershipKey | string | Unique member key provided by ReKonect |
externalId | string | Custom external identifier (e.g., barcode, app ID, etc.) |
At least one of
phoneNumber,membershipKeyis required.
Do not send empty fields or null values. Only include fields that are known and valid.
Single Member Example
{
"customer": {
"phoneNumber": "530229344"
}
}
Multiple Members Example
Some endpoints allow identifying more than one member at once (e.g., campaign or event triggers). Use a customers array in these cases.
{
"customers": [
{
"phoneNumber": "530229344"
},
{
"membershipKey": "0fe31b8b-5ad5-48af-81e9-4adc7d596042"
}
]
}
All Identifiers Example
You may include multiple identifiers if available. This helps increase accuracy of member matching.
{
"customer": {
"phoneNumber": "530229344",
"email": "john.doe@example.com",
"membershipKey": "0fe31b8b-5ad5-48af-81e9-4adc7d596042",
"externalId": "BARCODE-123456"
}
}
Tips and Best Practices
- Minimal input: Only include fields you are confident about.
- Sensitive data: Ensure member identifiers are securely transmitted over HTTPS.
- Consistency: Always use the same identifier format (e.g., phone numbers without leading zeros or country codes unless required).
Related Fields
This object is often used inside larger request bodies (e.g., alongside transaction, event, payment). You’ll find customer or member in most ReKonect API payloads.