Sign in

v1

latestOpenAPI 3.0.12026-07-21191548.4 KB
Customer Enrollment & Profile

Update customer loyalty status

post/loyalty/cp/api/update-customer-status

Request body

customerIdinteger

Unique identifier of the customer

dobstring date

Customer date of birth

status'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER' | 'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'

Customer loyalty status

Example request

{
  "customerId": 0,
  "dob": "2026-01-12",
  "status": "ACTIVE"
}

Response

Customer status updated successfully

availablePointsnumber double required
availableStoreCreditsnumber double
createAtstring date-time required
customerIdinteger required
displayNamestring
dobstring date
emailstring
emailBouncedOrFailedboolean
emailSettingstring
enableEmailboolean
enableEmailMarketingboolean
enableSmsMarketingboolean
firstNamestring
idinteger
isDeletedFromShopifyboolean
lastActivitystring date-time
lastMonthlyReminderSentDatestring date-time
lastNamestring
lastRewardExpiryReminderSentDatestring date-time
loyaltyProgramEnabledboolean
ordersCountinteger
pendingPointsnumber double required
phonestring
redeemLimitinteger
redeemLimitOnceinteger
redeemedPointsnumber double
shopstring required
skipReviewboolean
spentAmountnumber double
status'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'
storeCreditAccountIdstring
tagsstring
tokenstring
updatedSettingsstring
vipAssignType'MANUAL' | 'AUTO_RENEWAL' | 'RENEWAL_ON_HIGHER_TIER'
vipTierstring
vipTierAmountnumber double
vipTierExpiredAtstring date-time
vipTierIdinteger
vipTierSummarystring