PUT
/
v1
/
members
curl --request PUT \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "f90a1da5-c072-48b7-a9ea-eb35c5dd506b",
  "firstName": "John",
  "middleName": "M",
  "lastName": "Williams",
  "suffix": "<string>",
  "gender": "Male",
  "birthDate": "1980-11-30",
  "emailAddress": "user@abc.com",
  "phoneNumber": "923331234567",
  "addressLine1": "10400 NE 4th St",
  "addressLine2": "Suite 505",
  "addressLine3": "null",
  "city": "Bellevue",
  "region": "Wisconsin",
  "postalCode": "98004",
  "country": "United States",
  "maritalStatus": "Single",
  "prefix": "Mr",
  "redemptionChoice": "Auto",
  "redemptionThreshold": 10,
  "enrollmentStore": "www.demostore.come",
  "enrollmentDate": "2021-01-15",
  "lastPaidStatusCenter": "1201",
  "lastPaidStatusDate": "2021-01-15",
  "tierReference": "GOLD",
  "tierExpirationDatetime": "2026-01-15T23:59:59.000Z",
  "customAttributes": {
    "joiningDate": "2021-07-26",
    "confirmationDate": "2021-07-26"
  }
}'
{
  "message": "Member updated",
  "errors": {
    "ExceptionString": []
  },
  "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": 200
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Details to update in the member information. Fields that are allowed to update are governed by company configuration.

​
profileId
string
required

Profile ID of the member to update

Example:

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

​
firstName
string

First name of member

Required string length: 1 - 100
Example:

"John"

​
middleName
string

Middle name of member

Example:

"M"

​
lastName
string

Last name of member

Required string length: 1 - 100
Example:

"Williams"

​
suffix
string

Suffix member

​
gender
enum<string>

Gender of member

Available options:
None,
Male,
Female,
Other
Example:

"Male"

​
birthDate
string

Date of birth of member

Example:

"1980-11-30"

​
emailAddress
string

Email address given during enrollment

Required string length: 1 - 254
Example:

"user@abc.com"

​
phoneNumber
string

Phone number given for enrollment (without space or dash)

Minimum length: 1
Example:

"923331234567"

​
addressLine1
string | null

Line 1 of address

Maximum length: 500
Example:

"10400 NE 4th St"

​
addressLine2
string | null

Line 2 of address

Maximum length: 500
Example:

"Suite 505"

​
addressLine3
string | null

An additional line for directional information

Maximum length: 500
Example:

null

​
city
string

City name of address

Maximum length: 50
Example:

"Bellevue"

​
region
string

State name of address

Maximum length: 150
Example:

"Wisconsin"

​
postalCode
string

Zip code of address

Example:

"98004"

​
country
string

Country name of address

Minimum length: 1
Example:

"United States"

​
maritalStatus
enum<string>

Marital status of the member

Available options:
None,
Single,
Married,
Divorced,
Widowed,
Separated
Example:

"Single"

​
prefix
enum<string>

Prefix (if appliable) of the member name

Available options:
None,
Mr,
Mrs,
Ms
Example:

"Mr"

​
redemptionChoice
enum<string>

Redemption options are Bank and Auto. If the redemptionChoice is Auto the points are automatically converted to rewards. When the redemptionChoice is Bank the points are converted to rewards at the member’s request.

Available options:
Bank,
Auto
Example:

"Auto"

​
redemptionThreshold
string
default:0.00

Points can be redeemed only when they reach a defined threshold value

Example:

10

​
enrollmentStore
string

Store name (physical entire/store or a website) where member was enrolled.

Minimum length: 1
Example:

"www.demostore.come"

​
enrollmentDate
string

Date of member enrollment

Example:

"2021-01-15"

​
lastPaidStatusCenter
string

Entity or store where the pro membership was purchased (for the paid tier).

Minimum length: 1
Example:

"1201"

​
lastPaidStatusDate
string

Date to update the paid status

Example:

"2021-01-15"

​
tierReference
string

Reference-name of the tier to assign member to

Example:

"GOLD"

​
tierExpirationDatetime
string

Tier expiration date-time. Only utilized if tierReference is specified

Example:

"2026-01-15T23:59:59.000Z"

​
customAttributes
object

A dictionary representing the custom fields.

Example:
{
  "joiningDate": "2021-07-26",
  "confirmationDate": "2021-07-26"
}

Response

200
application/json

Member updated

Response for the member update request

​
message
string
default:Exception message

Message corresponding to the call

Minimum length: 1
Example:

"Member updated"

​
errors
object

A dictionary of lists with different number of errors or exceptions

Example:
{ "ExceptionString": [] }
​
data
object

Member details

​
status
integer

Status code of call

Example:

200