Enroll Member

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Wayne",
  "emailAddress": "[email protected]",
  "phoneNumber": "923331234567",
  "entityReference": "BOUNTEE_CLUB",
  "clubReference": "BLOCK_A",
  "middleName": "Duke",
  "suffix": "<string>",
  "gender": "Male",
  "birthDate": "1990-11-16",
  "addressLine1": "10400 NE 4th St",
  "addressLine2": "Suite 505",
  "addressLine3": "",
  "city": "Austin",
  "region": "Texas",
  "postalCode": "98004",
  "country": "United States",
  "nationality": "",
  "maritalStatus": "Single",
  "prefix": "Mr",
  "redemptionChoice": "Auto",
  "redemptionThreshold": 10,
  "enrollmentTimestamp": "2021-01-25",
  "enrollReasonCode": "1234",
  "enrollReasonNote": "As guest member",
  "tierReference": "Silver",
  "customAttributes": {},
  "sourceExternalReference": "example.com",
  "channelExternalReference": "WEB"
}
'

{
  "message": "Created",
  "errors": {},
  "data": {
    "accounts": [
      {
        "accountStatus": "Enabled",
        "clubReference": "abc_club",
        "clubTitle": "ABC Club",
        "customAttributes": {
          "memberSinceDate": "2021-07-26",
          "enrolledAtCenter": "Liberty Store",
          "profileCompleted": false
        },
        "enrollmentEntity": "demo",
        "enrollmentStatus": true,
        "entityReference": "entity_level_1",
        "loyaltyNumber": "10000147371",
        "paidStatus": false,
        "profileId": "f90a1da5-c072-48b7-a9ea-eb35c5dd506b",
        "redemptionChoice": "Auto",
        "redemptionThreshold": 10,
        "tierExpiryDate": "2022-09-17T14:26:32.192148+00:00",
        "tierExternalReference": "GLD",
        "tierId": 4185,
        "tierTitle": "ClubTier",
        "updatedAt": "2021-11-01 12:15:53.831401+00:00"
      }
    ],
    "addressLine1": "10400 NE 4th St",
    "addressLine2": "Suite 505",
    "addressLine3": "",
    "birthdate": "1990-11-16",
    "channelExternalReference": "Web",
    "city": "Austin",
    "country": "US",
    "emailAddress": "[email protected]",
    "enrollReasonCode": "1234",
    "enrollReasonNote": "Guest",
    "enrollmentTimestamp": "2021-09-14T11:32:55.508949Z",
    "firstName": "John",
    "fullCountry": "United States",
    "fullRegion": "Texas",
    "gender": "Male",
    "lastName": "Wayne",
    "maritalStatus": "None",
    "middleName": "Duke",
    "nationality": "",
    "phoneNumber": "923331234567",
    "postalCode": "98004",
    "prefix": "Mr",
    "region": "TX",
    "sourceExternalReference": "www.abcdemo.com",
    "suffix": "<string>"
  },
  "status": 201
}

POST

members

Enroll Member

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Wayne",
  "emailAddress": "[email protected]",
  "phoneNumber": "923331234567",
  "entityReference": "BOUNTEE_CLUB",
  "clubReference": "BLOCK_A",
  "middleName": "Duke",
  "suffix": "<string>",
  "gender": "Male",
  "birthDate": "1990-11-16",
  "addressLine1": "10400 NE 4th St",
  "addressLine2": "Suite 505",
  "addressLine3": "",
  "city": "Austin",
  "region": "Texas",
  "postalCode": "98004",
  "country": "United States",
  "nationality": "",
  "maritalStatus": "Single",
  "prefix": "Mr",
  "redemptionChoice": "Auto",
  "redemptionThreshold": 10,
  "enrollmentTimestamp": "2021-01-25",
  "enrollReasonCode": "1234",
  "enrollReasonNote": "As guest member",
  "tierReference": "Silver",
  "customAttributes": {},
  "sourceExternalReference": "example.com",
  "channelExternalReference": "WEB"
}
'

{
  "message": "Created",
  "errors": {},
  "data": {
    "accounts": [
      {
        "accountStatus": "Enabled",
        "clubReference": "abc_club",
        "clubTitle": "ABC Club",
        "customAttributes": {
          "memberSinceDate": "2021-07-26",
          "enrolledAtCenter": "Liberty Store",
          "profileCompleted": false
        },
        "enrollmentEntity": "demo",
        "enrollmentStatus": true,
        "entityReference": "entity_level_1",
        "loyaltyNumber": "10000147371",
        "paidStatus": false,
        "profileId": "f90a1da5-c072-48b7-a9ea-eb35c5dd506b",
        "redemptionChoice": "Auto",
        "redemptionThreshold": 10,
        "tierExpiryDate": "2022-09-17T14:26:32.192148+00:00",
        "tierExternalReference": "GLD",
        "tierId": 4185,
        "tierTitle": "ClubTier",
        "updatedAt": "2021-11-01 12:15:53.831401+00:00"
      }
    ],
    "addressLine1": "10400 NE 4th St",
    "addressLine2": "Suite 505",
    "addressLine3": "",
    "birthdate": "1990-11-16",
    "channelExternalReference": "Web",
    "city": "Austin",
    "country": "US",
    "emailAddress": "[email protected]",
    "enrollReasonCode": "1234",
    "enrollReasonNote": "Guest",
    "enrollmentTimestamp": "2021-09-14T11:32:55.508949Z",
    "firstName": "John",
    "fullCountry": "United States",
    "fullRegion": "Texas",
    "gender": "Male",
    "lastName": "Wayne",
    "maritalStatus": "None",
    "middleName": "Duke",
    "nationality": "",
    "phoneNumber": "923331234567",
    "postalCode": "98004",
    "prefix": "Mr",
    "region": "TX",
    "sourceExternalReference": "www.abcdemo.com",
    "suffix": "<string>"
  },
  "status": 201
}

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

firstName

string

required

First name of member

Required string length: 1 - 100

Example:

"John"

lastName

string

required

Last name of member

Required string length: 1 - 100

Example:

"Wayne"

emailAddress

string<email>

required

Email address of the member

Required string length: 1 - 254

Example:

"[email protected]"

phoneNumber

string

required

Phone number of member (without space or dash).

Required string length: 1 - 16

Example:

"923331234567"

entityReference

string

required

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

Minimum string length: 1

Example:

"BOUNTEE_CLUB"

clubReference

string

required

Club name or ID where the member is enrolled

Minimum string length: 1

Example:

"BLOCK_A"

middleName

string

Middle name of member

Maximum string length: 100

Example:

"Duke"

suffix

string | null

Suffix of the member name, if any.

gender

enum<string>

Gender of member

Available options:

None,

Male,

Female,

Other

Example:

"Male"

birthDate

string<date>

Date of birth of member

Example:

"1990-11-16"

addressLine1

string | null

Line 1 of address

Maximum string length: 500

Example:

"10400 NE 4th St"

addressLine2

string | null

Line 2 of address

Maximum string length: 500

Example:

"Suite 505"

addressLine3

string | null

Additional line for directional information

Maximum string length: 500

Example:

""

city

string

City name of the address.

Maximum string length: 50

Example:

"Austin"

region

string

State name of address

Maximum string length: 150

Example:

"Texas"

postalCode

string

Zip code of address

Example:

"98004"

country

string

Country name

Minimum string length: 1

Example:

"United States"

nationality

string

Nationality of member

Example:

""

maritalStatus

enum<string>

Marital status of member

Available options:

None,

Single,

Married,

Divorced,

Widowed,

Separated

Example:

"Single"

prefix

enum<string>

Prefix (if appliable) of member name.

Available options:

None,

Mr,

Mrs,

Ms

Example:

"Mr"

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

Minimum string length: 1

Example:

"Auto"

redemptionThreshold

string | null

Threshold value (configurable) to redeem reward.

Example:

10

enrollmentTimestamp

string<date-time> | null

Date of member enrollment

Example:

"2021-01-25"

enrollReasonCode

string | null

Reason code for enrollment

Maximum string length: 30

Example:

"1234"

enrollReasonNote

string | null

Enrollment reason

Maximum string length: 300

Example:

"As guest member"

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).
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.

Example:

"Silver"

customAttributes

customAttributes · object

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

sourceExternalReference

string | null

Company website used for member enrollmen

Maximum string length: 100

Example:

"example.com"

channelExternalReference

string | null

Sales channel

Maximum string length: 100

Example:

"WEB"

Response

Created

Member details with current status

message

string

default:Exception message

Message corresponding to status

Minimum string length: 1

Example:

"Created"

errors

Errors · object

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

Example:

{}

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 string length: 1

Example:

"Enabled"

data.accounts.clubReference

string

Club name or ID where the member is enrolled.

Minimum string length: 1

Example:

"abc_club"

data.accounts.clubTitle

string

Club name

Minimum string length: 1

Example:

"ABC Club"

data.accounts.customAttributes

Customattributes · object

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

Example:

{
  "memberSinceDate": "2021-07-26",
  "enrolledAtCenter": "Liberty Store",
  "profileCompleted": false
}

data.accounts.enrollmentEntity

string

Store where the member is enrollment.

Minimum string length: 1

Example:

"demo"

data.accounts.enrollmentStatus

boolean

Status of the member's enrollment.

Example:

true

data.accounts.entityReference

string

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

Minimum string length: 1

Example:

"entity_level_1"

data.accounts.loyaltyNumber

string

Loyalty-number for this member account

Example:

"10000147371"

data.accounts.paidStatus

boolean

default:false

true: Paid membership
false: Free membership.

Example:

false

data.accounts.profileId

string<uuid>

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

Example:

"f90a1da5-c072-48b7-a9ea-eb35c5dd506b"

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

Minimum string length: 1

Example:

"Auto"

data.accounts.redemptionThreshold

string

Threshold value for redemption (configurable)

Example:

10

data.accounts.tierExpiryDate

string<date-time>

Tier expiry time, in UTC format

Example:

"2022-09-17T14:26:32.192148+00:00"

data.accounts.tierExternalReference

string

External reference of tier

Minimum string length: 1

Example:

"GLD"

data.accounts.tierId

integer<int32>

Tier ID

Example:

4185

data.accounts.tierTitle

string

Tier name (configurable)

Minimum string length: 1

Example:

"ClubTier"

data.accounts.updatedAt

string<date-time>

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

Example:

"2021-11-01 12:15:53.831401+00:00"

data.addressLine1

string | null

Line 1 of address

Maximum string length: 500

Example:

"10400 NE 4th St"

data.addressLine2

string | null

Line 2 of the address

Maximum string length: 500

Example:

"Suite 505"

data.addressLine3

string | null

For additional directional information.

Maximum string length: 500

Example:

""

data.birthdate

string

Date of birth of member

Example:

"1990-11-16"

data.channelExternalReference

string

Sales channel

Example:

"Web"

data.city

string

City name

Maximum string length: 50

Example:

"Austin"

data.country

string

Country abbreviation of the member

Minimum string length: 1

Example:

"US"

data.emailAddress

string

Email address of member

Example:

"[email protected]"

data.enrollReasonCode

string

Reason code for member enrollment

Maximum string length: 30

Example:

"1234"

data.enrollReasonNote

string

Reason for member enrollment

Maximum string length: 300

Example:

"Guest"

data.enrollmentTimestamp

string<date-time>

Date of member enrollment, in UTC format

Example:

"2021-09-14T11:32:55.508949Z"

data.firstName

string

First name of member

Example:

"John"

data.fullCountry

string

Country name of member

Example:

"United States"

data.fullRegion

string

Region name of member

Example:

"Texas"

data.gender

enum<string>

Gender of member

Available options:

None,

Male,

Female,

Other

Example:

"Male"

data.lastName

string

Last name of member

Example:

"Wayne"

data.maritalStatus

enum<string>

Available options:

None,

Single,

Married,

Divorced,

Widowed,

Separated

data.middleName

string

Middle name of member

Example:

"Duke"

data.nationality

string

Nationality of member

Example:

""

data.phoneNumber

string

Phone number used for enrollment (without space or dash)

Minimum string length: 1

Example:

"923331234567"

data.postalCode

string

Zip code of address

Example:

"98004"

data.prefix

enum<string>

Prefix associated with member name

Available options:

None,

Mr,

Mrs,

Ms

Example:

"Mr"

data.region

string

Region abbreviation of member

Maximum string length: 150

Example:

"TX"

data.sourceExternalReference

string

Website of parent company

Example:

"www.abcdemo.com"

data.suffix

string

Suffix of member name (if any)

status

integer<int32>

Request status

Example:

201

Get Members Activate Points

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Enroll Member

Authorizations

Body

Response