PUT
/
v1
/
members

Authorizations

Authorization
string
headerrequired

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

firstName
string

First name of member

Required string length: 1 - 100
middleName
string

Middle name of member

lastName
string

Last name of member

Required string length: 1 - 100
suffix
string

Suffix member

gender
enum<string>

Gender of member

Available options:
None,
Male,
Female,
Other
birthDate
string

Date of birth of member

emailAddress
string

Email address given during enrollment

Required string length: 1 - 254
phoneNumber
string

Phone number given for enrollment (without space or dash)

Minimum length: 1
addressLine1
string | null

Line 1 of address

Maximum length: 500
addressLine2
string | null

Line 2 of address

Maximum length: 500
addressLine3
string | null

An additional line for directional information

Maximum length: 500
city
string

City name of address

Maximum length: 50
region
string

State name of address

Maximum length: 150
postalCode
string

Zip code of address

country
string

Country name of address

Minimum length: 1
maritalStatus
enum<string>

Marital status of the member

Available options:
None,
Single,
Married,
Divorced,
Widowed,
Separated
prefix
enum<string>

Prefix (if appliable) of the member name

Available options:
None,
Mr,
Mrs,
Ms
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
redemptionThreshold
string
default: 0.00

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

enrollmentStore
string

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

Minimum length: 1
enrollmentDate
string

Date of member enrollment

lastPaidStatusCenter
string

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

Minimum length: 1
lastPaidStatusDate
string

Date to update the paid status

tierReference
string

Reference-name of the tier to assign member to

tierExpirationDatetime
string

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

customAttributes
object

A dictionary representing the custom fields.

Response

200 - application/json

Response for the member update request

message
string
default: Exception message

Message corresponding to the call

Minimum length: 1
errors
object

A dictionary of lists with different number of errors or exceptions

data
object

Member details

status
integer

Status code of call

Was this page helpful?

Get TransactionsGet Members