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

headerrequired

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

Body

application/json

Member details with contact information

firstName

string

required

First name of member

Required string length: 1 - 100

lastName

string

required

Last name of member

Required string length: 1 - 100

emailAddress

string

required

Email address of the member

Required string length: 1 - 254

phoneNumber

string

required

Phone number of member (without space or dash).

Required string length: 1 - 16

entityReference

string

required

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

Minimum length: 1

clubReference

string

required

Club name or ID where the member is enrolled

Minimum length: 1

middleName

string

Middle name of member

Maximum length: 100

suffix

string | null

Suffix of the member name, if any.

gender

enum<string>

Gender of member

Available options:

None,

Male,

Female,

Other

birthDate

string

Date of birth of member

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

city

string

City name of the address.

Maximum length: 50

region

string

State name of address

Maximum length: 150

postalCode

string

Zip code of address

country

string

Country name

Minimum length: 1

nationality

string

Nationality of member

maritalStatus

enum<string>

Marital status of member

Available options:

None,

Single,

Married,

Divorced,

Widowed,

Separated

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.

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

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.

customAttributes

object | null

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

sourceExternalReference

string | null

Company website used for member enrollmen

Maximum length: 100

channelExternalReference

string | null

Sales channel

Maximum length: 100

Response

201 - application/json

Member details with current status

message

string

default: Exception message

Message corresponding to status

Minimum length: 1

errors

object

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

data

object

Member details

Show child attributes

status

integer

Request status