Enroll Member

After setting up your loyalty program with fabric, the next crucial step is to enroll members to the program. This endpoint enrolls a loyalty member into a default tier associated with a club.
Note: Only a single member can be enrolled at a time.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Member details with contact information

clubReference

string

required

Club name or ID where the member is enrolled

Minimum length: 1

emailAddress

string

required

Email address of the member

Required string length: 1 - 254

entityReference

string

required

Name or ID of store (or entity) where the member is enrolled.

Minimum length: 1

firstName

string

required

First name of member

Required string length: 1 - 100

lastName

string

required

Last name of member

Required string length: 1 - 100

phoneNumber

string

required

Phone number of member (without space or dash).

Required string length: 1 - 16

addressLine1

string | null

Line 1 of address

Maximum length: 500

addressLine2

string | null

Line 2 of address

Maximum length: 500

addressLine3

string | null

Additional line for directional information

Maximum length: 500

birthDate

string

Date of birth of member

channelExternalReference

string | null

Sales channel

Maximum length: 100

city

string

City name of the address.

Maximum length: 50

country

string

Country name

Minimum length: 1

customAttributes

object | null

Inputs from the store (if applicable) and stored without validation.

enrollmentTimestamp

string | null

Date of member enrollment

enrollReasonCode

string | null

Reason code for enrollment

Maximum length: 30

enrollReasonNote

string | null

Enrollment reason

Maximum length: 300

gender

enum<string>

Gender of member

Available options:

None,

Male,

Female,

Other

maritalStatus

enum<string>

Marital status of member

Available options:

None,

Single,

Married,

Divorced,

Widowed,

Separated

middleName

string

Middle name of member

Maximum length: 100

nationality

string

Nationality of member

postalCode

string

Zip code of address

prefix

enum<string>

Prefix (if appliable) of member name.

Available options:

None,

Mr,

Mrs,

Ms

redemptionChoice

enum<string> | null

Redemption choices are Bank and Auto. When the choice is 'auto,' the points are automatically converted to rewards. When the choice is 'bank,' the points are converted to rewards at the member’s request.

Available options:

Bank,

Auto

redemptionThreshold

string | null

Threshold value (configurable) to redeem reward.

region

string

State name of address

Maximum length: 150

sourceExternalReference

string | null

Company website used for member enrollmen

Maximum length: 100

suffix

string | null

Suffix of the member name, if any.

tierReference

string | null

Tiers are always setup at the club level and a number of tiers can be created. Tiers are categorized as Free (Predefined names are Bronze, Silver, Gold) and Paid (Example - Pro). <br /> Note: Tier names and the rules to move up and down the tiers are configurable. In addition, points, rewards, and tier expiration can be setup at the tier level.

Response

201 - application/json

Member details with current status

data

object

Member details

Show child attributes

data.accounts

object[]

Member account details

Show child attributes

data.accounts.accountStatus

string

Account status such as enabled, disabled, etc.

Minimum length: 1

data.accounts.clubReference

string

Club name or ID where the member is enrolled.

Minimum length: 1

data.accounts.clubTitle

string

Club name

Minimum length: 1

data.accounts.customAttributes

object

Account details as shared by the business. The details are stored in the LMS as provided, and without validation.

data.accounts.enrollmentEntity

string

Store where the member is enrollment.

Minimum length: 1

data.accounts.enrollmentStatus

boolean

Status of the member's enrollment.

data.accounts.entityReference

string

Name or ID for the store (or entity) where the member is enrolled.

Minimum length: 1

data.accounts.loyaltyNumber

string

Loyalty-number for this member account

data.accounts.paidStatus

boolean

default:

false

true: Paid membership <br /> false: Free membership.

data.accounts.profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

data.accounts.redemptionChoice

enum<string> | null

Redemption choices are Bank and Auto. When the redemptionChoice is auto the points are automatically converted to rewards. When the redemptionChoice is bank the points are converted to rewards only on member’s request.

Available options:

Bank,

Auto

data.accounts.redemptionThreshold

string

Threshold value for redemption (configurable)

data.accounts.tierExpiryDate

string

Tier expiry time, in UTC format

data.accounts.tierExternalReference

string

External reference of tier

Minimum length: 1

data.accounts.tierId

integer

Tier ID

data.accounts.tierTitle

string

Tier name (configurable)

Minimum length: 1

data.accounts.updatedAt

string

Timestamp of when the member account was last updated (UTC format)

data.addressLine1

string | null

Line 1 of address

Maximum length: 500

data.addressLine2

string | null

Line 2 of the address

Maximum length: 500

data.addressLine3

string | null

For additional directional information.

Maximum length: 500

data.birthdate

string

Date of birth of member

data.channelExternalReference

string

Sales channel

data.city

string

City name

Maximum length: 50

data.country

string

Country abbreviation of the member

Minimum length: 1

data.emailAddress

string

Email address of member

data.enrollmentTimestamp

string

Date of member enrollment, in UTC format

data.enrollReasonCode

string

Reason code for member enrollment

Maximum length: 30

data.enrollReasonNote

string

Reason for member enrollment

Maximum length: 300

data.firstName

string

First name of member

data.fullCountry

string

Country name of member

data.fullRegion

string

Region name of member

data.gender

enum<string>

Gender of member

Available options:

None,

Male,

Female,

Other

data.lastName

string

Last name of member

data.maritalStatus

enum<string>

Available options:

None,

Single,

Married,

Divorced,

Widowed,

Separated

data.middleName

string

Middle name of member

data.nationality

string

Nationality of member

data.phoneNumber

string

Phone number used for enrollment (without space or dash)

Minimum length: 1

data.postalCode

string

Zip code of address

data.prefix

enum<string>

Prefix associated with member name

Available options:

None,

Mr,

Mrs,

Ms

data.region

string

Region abbreviation of member

Maximum length: 150

data.sourceExternalReference

string

Website of parent company

data.suffix

string

Suffix of member name (if any)

errors

object

A dictionary of lists with different number of errors or exceptions.

message

string

default:

Exception message

Message corresponding to status

Minimum length: 1

status

integer

Request status