Newer Version Available
Individual Member Enrollments
Enroll an individual member in a loyalty program, while asynchronously sending data to
the Individual Member Enrollments API.
Resource
Signature
Input Parameters
| Parameter | Type | Description | Required or Optional |
|---|---|---|---|
| String | Email address of the member being enrolled. | Required | |
| emailNotification | Boolean | Indicates whether the member wants to receive email notifications ((true)) or not ((false)). | Required |
| firstName | String | First name of the member being enrolled. | Required |
| lastName | String | Last name of the member being enrolled. | Required |
| membershipNumber | String | Membership number of the member being enrolled. | Required |
| phone | String | Phone number of the member being enrolled. | Required |
| version | String | Version of the API. The request body is available in version 55.0 and later. | Optional |
Return Value
An EnrollmentOutputModel instance of type:
Sample Output
Output Parameters
| Parameter | Type | Description |
|---|---|---|
| activityDate | String | The date and time of when transaction journal is created. |
| contactId | String | The ID of the loyalty program member’s person account. |
| journalSubType | String | The journal subtype of the transaction journal. |
| journalType | String | The journal type of the transaction journal. |
| loyaltyProgram | String | The loyalty program related with the transaction journal. |
| loyaltyProgramMember | String | The membership number of the loyalty program related to the transaction journal. |
| loyaltyProgramMemberId | String | The ID of the loyalty program member record created for the member. |
| loyaltyProgramName | String | The name of the loyalty program into which the member is enrolled. |
| membershipNumber | String | The membership number of the enrolled member. |
| referredMember | String | The membership number of the loyalty program member who has been referred by the member. |
| status | String | The status of the transaction journal. |
| transactionJournalId | String | The ID of the transaction journal that is created. |