Members
Enroll Member
Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Members
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.
POST
/
v1
/
members
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",
"middleName": "Duke",
"lastName": "Wayne",
"suffix": "<string>",
"gender": "Male",
"birthDate": "1990-11-16",
"emailAddress": "user@abc.com",
"phoneNumber": "923331234567",
"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,
"entityReference": "BOUNTEE_CLUB",
"enrollmentTimestamp": "2021-01-25",
"clubReference": "BLOCK_A",
"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": "user@abc.com",
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Member details with contact information
Response
201
application/json
Created
Member details with current status
Was this page helpful?
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",
"middleName": "Duke",
"lastName": "Wayne",
"suffix": "<string>",
"gender": "Male",
"birthDate": "1990-11-16",
"emailAddress": "user@abc.com",
"phoneNumber": "923331234567",
"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,
"entityReference": "BOUNTEE_CLUB",
"enrollmentTimestamp": "2021-01-25",
"clubReference": "BLOCK_A",
"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": "user@abc.com",
"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
}