Update Member

Updates details of an existing member.
Note: Only a single member can be updated 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

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:

"[e-mail]"

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

Show child attributes

data.accounts

object[]

Member account details

Member account details as shared by the business.

Show child attributes

data.accounts.accountStatus

string

Account status such as enabled, disabled, etc.

Minimum length: 1

Example:

"Enabled"

data.accounts.clubReference

string

Club name or ID where the member is enrolled.

Minimum length: 1

Example:

"abc_club"

data.accounts.clubTitle

string

Club name

Minimum length: 1

Example:

"ABC Club"

data.accounts.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 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 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 <br /> false: Free membership.

Example:

false

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.

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

Example:

"Auto"

data.accounts.redemptionThreshold

string

Threshold value for redemption (configurable)

Example:

10

data.accounts.tierExpiryDate

string

Tier expiry time, in UTC format

Example:

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

data.accounts.tierExternalReference

string

External reference of tier

Minimum length: 1

Example:

"GLD"

data.accounts.tierId

integer

Tier ID

Example:

4185

data.accounts.tierTitle

string

Tier name (configurable)

Minimum length: 1

Example:

"ClubTier"

data.accounts.updatedAt

string

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 length: 500

Example:

"10400 NE 4th St"

data.addressLine2

string | null

Line 2 of the address

Maximum length: 500

Example:

"Suite 505"

data.addressLine3

string | null

For additional directional information.

Maximum 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 length: 50

Example:

"Austin"

data.country

string

Country abbreviation of the member

Minimum length: 1

Example:

"US"

data.emailAddress

string

Email address of member

Example:

"[e-mail]"

data.enrollReasonCode

string

Reason code for member enrollment

Maximum length: 30

Example:

"1234"

data.enrollReasonNote

string

Reason for member enrollment

Maximum length: 300

Example:

"Guest"

data.enrollmentTimestamp

string

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

Status code of call

Example:

200