--- title: Find Members / Verify Member slug: find-members-verify-member docTags: createdAt: 2025-09-12T20:51:26.463Z --- { "id": "T9T6qmnCt72-Phy-C5HwK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.b.preview.loyaltyservices.io/api/v3/members", "servers": [ { "url": "https://api.b.preview.loyaltyservices.io/api/v3/members" } ], "name": "Find Members / Verify Member", "description": "

Search for members by name, email, phone, or other demographic attributes.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "memberIdentifier", "type": "string", "description": "

External account identifier (e.g. loyalty account number).

" }, { "kind": "optional", "name": "memberIds", "type": "array", "description": "

Comma-separated internal member identifiers. Return the profile details for the matching memberIds.

", "schema": [], "itemType": "integer", "customType": "integer[]" }, { "kind": "optional", "name": "firstName", "type": "string", "description": "Search for members by first name." }, { "kind": "optional", "name": "middleName", "type": "string", "description": "Search for members by middle name." }, { "kind": "optional", "name": "lastName", "type": "string", "description": "Search for members by last name." }, { "kind": "optional", "name": "includeReversedName", "type": "boolean", "description": "Searches for both \"firstName lastName\" and \"lastName firstName\" combinations", "default": false }, { "kind": "optional", "name": "statusCode", "type": "string", "description": "Limits return to all members of this status" }, { "kind": "optional", "name": "company", "type": "string", "description": "Limits return based on company" }, { "kind": "optional", "name": "accountType", "type": "string", "description": "Limits return based on accountType" }, { "kind": "optional", "name": "tierCode", "type": "string", "description": "Limits return to all members of this tier" }, { "kind": "optional", "name": "email", "type": "string", "description": "Limits return based on email address" }, { "kind": "optional", "name": "phoneNumber", "type": "string", "description": "Limits return based on phone number" }, { "kind": "optional", "name": "city", "type": "string", "description": "Limits return to all members with this City demographic" }, { "kind": "optional", "name": "stateCode", "type": "string", "description": "Limits return to all members with this state code demographic" }, { "kind": "optional", "name": "zip", "type": "string", "description": "Limits return to all members with this Zip demographic" }, { "kind": "optional", "name": "countryCode", "type": "string", "description": "Limits return to all members with this country code demographic" }, { "kind": "optional", "name": "aliasIdentifier", "type": "string", "description": "Limits return to all members with this alias" }, { "kind": "optional", "name": "aliasType", "type": "string", "description": "

Used in conjunction with aliasIdentifier, limits return to all members with this aliasType

" }, { "kind": "optional", "name": "testAccount", "type": "boolean", "description": "

If using, only test accounts will be returned

" }, { "kind": "optional", "name": "includeAddresses", "type": "boolean", "description": "Include member's addresses" }, { "kind": "optional", "name": "includeEmails", "type": "boolean", "description": "Include member's emails" }, { "kind": "optional", "name": "includePhones", "type": "boolean", "description": "Include member's phones" }, { "kind": "optional", "name": "includePaymentCardAccounts", "type": "boolean", "description": "

Include member's payment (credit) card accounts. Defaults to false.

" }, { "kind": "optional", "name": "includeAliases", "type": "boolean", "description": "Include member's aliases" }, { "kind": "optional", "name": "includeCurrencies", "type": "boolean", "description": "Include member's currencies" }, { "kind": "optional", "name": "includePreferences", "type": "boolean", "description": "Include member's preferences" }, { "kind": "optional", "name": "includeAuthorizedMembers", "type": "boolean", "description": "Include authorized members for the member. Authorized members are people identified who are allowed to make changes to the account when contacted by Member Services" }, { "kind": "optional", "name": "includeMemberLists", "type": "boolean", "description": "Includes the active member lists" }, { "kind": "optional", "name": "includeOnlyDisplayableLists", "type": "boolean", "description": "

This parameter only applies when includeMemberLists is set to true; it has no effect otherwise. When set to true, only member lists with the displayInCC flag enabled are returned.Tally CC by default is only authorized to see lists that has this flag set to true. When set to false, all member lists are returned.

", "default": false }, { "kind": "optional", "name": "includeInactive", "type": "boolean", "description": "

Returns inactive emails, phones, payment cards, and member lists in addition to active ones.

", "default": false }, { "kind": "optional", "name": "matchMode", "type": "string", "example": "Start, Exact", "description": "

Specifies the type of search behavior to use with the provided query parameters. This setting controls wildcard placement and matching logic. Available options include -, Start - Applies wildcard matching from the beginning of the search term ,Exact - Performs precise matching without wildcard expansion

", "enum": [ "START", "EXACT" ] } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

See https://docs.wearephaedon.com/docs/platform-api-authentication

", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications" } } }, "requiredScopes": [ "api:member:verify", "api:member:search" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "MemberProfile[]", "schema": [ { "name": "memberIdentifier", "kind": "optional", "type": "string", "description": "

Channel/Partner specific member identifier

", "minLength": 1, "maxLength": 200 }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Loyalty Account Number", "minLength": 7, "maxLength": 25 }, { "name": "mergeSurvivorMemberIdentifier", "kind": "optional", "type": "string", "description": "

Channel/Partner specific member identifier of Merge Survivor

", "minLength": 1, "maxLength": 200 }, { "name": "mergeSurvivorAccountNumber", "kind": "optional", "type": "string", "description": "Account Number of Merge Survivor", "minLength": 7, "maxLength": 25 }, { "name": "accountTypeCode", "kind": "optional", "type": "string", "description": "

Classification of the loyalty account. Default value is MBR (Member). Values for this field need to match datacodes setup with a CodeType of: AccountType

" }, { "name": "title", "kind": "optional", "type": "string", "description": "

Member's title, such as Mr. Mrs. Ms. etc.

", "minLength": 1, "maxLength": 100 }, { "name": "firstName", "kind": "optional", "type": "string", "description": "Member's first name", "minLength": 1, "maxLength": 100 }, { "name": "middleName", "kind": "optional", "type": "string", "description": "Member's middle name", "minLength": 1, "maxLength": 100 }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Member's last name", "minLength": 1, "maxLength": 100 }, { "name": "suffix", "kind": "optional", "type": "string", "description": "

Member's suffix, such as Jr. Sr.

" }, { "name": "birthDate", "kind": "optional", "type": "string", "description": "Member's date of birth", "format": "date" }, { "name": "enrollmentCode", "kind": "optional", "type": "string", "description": "Enrollment Code" }, { "name": "enrollmentDateTime", "kind": "optional", "type": "string", "description": "DateTime of member enrollment", "format": "date-time" }, { "name": "enrollmentDeviceTypeCode", "kind": "optional", "type": "string", "description": "

Device type logged at time of enrollment. Auto-generated if not provided. Only populated when enabled in the client program configuration. Values for this field need to match datacodes setup with a CodeType of: DeviceType

" }, { "name": "enrollmentLocation", "kind": "optional", "type": "string", "description": "Identifier of enrollment", "minLength": 0, "maxLength": 50 }, { "name": "enrollmentEmployee", "kind": "optional", "type": "string", "description": "Identifier for enrollment employee", "minLength": 0, "maxLength": 50 }, { "name": "enrollmentSourceCode", "kind": "optional", "type": "string", "description": "

Client-configurable code indicating the channel or method through which the member enrolled. Values for this field need to match datacodes setup with a CodeType of: EnrollmentSource

" }, { "name": "accountStatusCode", "kind": "optional", "type": "string", "description": "

Current status of the member account. Standard values: A = Active, P = Pending, I = Inactive, C = Closed, S = Shell. Labels may vary by client program — see accountStatusCodeDescription for the program-specific label. Values for this field need to match datacodes setup with a CodeType of: MemberStatus

" }, { "name": "accountStatusCodeDescription", "kind": "optional", "type": "string", "description": "

Account Status Description - description is defined by Client Program. Standard Values. Active, Pending, Inactive, Closed, Shell

" }, { "name": "accountStatusUpdateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "DateTime of the last time the member status was updated", "format": "date-time" }, { "name": "accountStatusUpdateUser", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who last updated the member status" }, { "name": "closedReasonCode", "kind": "optional", "type": "string", "description": "

Reason the member account was closed. Only populated when accountStatusCode is C (Closed). Values for this field need to match datacodes setup with a CodeType of: CloseReason

" }, { "name": "closedStatusComment", "kind": "optional", "type": "string", "description": "Account closed status update comments" }, { "name": "closedDate", "kind": "optional", "type": "string", "description": "Account closed date", "format": "date" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "

Company/business associated with member

", "minLength": 1, "maxLength": 100 }, { "name": "genderCode", "kind": "optional", "type": "string", "description": "

Member's self-identified gender. M = Male, F = Female, U = Unknown/Unspecified.

" }, { "name": "language", "kind": "optional", "type": "string", "description": "Member's language preference." }, { "name": "testAccount", "kind": "optional", "type": "boolean", "description": "

Flag to indicate that member is a test account and should not be included in reporting, assessments and compensation. Will default to false if not provided.

" }, { "name": "scrubbed", "kind": "optional", "type": "boolean", "description": "Flag to indicate that member details are removed" }, { "name": "onlineActivationDateTime", "kind": "optional", "type": "string", "description": "Date when member account was activated. One will be generated if not provided. Only valid if enabled on Client program configuration.", "format": "date-time" }, { "name": "updateDateTime", "kind": "optional", "type": "string", "description": "DateTime of the last time the member was updated", "format": "date-time" }, { "name": "asciiFirstName", "kind": "optional", "type": "string", "description": "ASCII member's first name. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiMiddleName", "kind": "optional", "type": "string", "description": "ASCII member's middle name. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiNickName", "kind": "optional", "type": "string", "description": "ASCII member's nick name. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiLastName", "kind": "optional", "type": "string", "description": "ASCII member's last name. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiSuffix", "kind": "optional", "type": "string", "description": "ASCII member's suffix. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiTitle", "kind": "optional", "type": "string", "description": "ASCII member's title. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiLanguage", "kind": "optional", "type": "string", "description": "ASCII member's language preference. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "closeable", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Closeable", "customType": "Closeable", "schema": [ { "name": "closeable", "kind": "optional", "type": "boolean", "description": "Flag to indicate if the account is closeable or not", "example": false }, { "name": "code", "kind": "optional", "type": "string", "description": "Code for closeable reason", "example": "12001" }, { "name": "reason", "kind": "optional", "type": "string", "description": "Reason details for closeable reason", "example": "Member has negative point balance and cannot be closed or merged." } ] }, { "name": "currentTier", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/MemberTier", "customType": "MemberTier", "schema": [ { "name": "tierCode", "kind": "required", "type": "string", "description": "Code of tier", "example": "B" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of tier", "example": "Base", "minLength": 0, "maxLength": 10 }, { "name": "rank", "kind": "required", "type": "integer", "description": "

Hierarchy of tier - higher ranks are more elite

", "example": 10, "format": "int32" }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Type of tier. Valid Values: Earned, Trial, Exclusive

", "example": "Earned" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Date the tier starts", "example": "2020-01-01", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Date the tier ends", "example": "2020-12-31", "format": "date" }, { "name": "grandFathered", "kind": "optional", "type": "boolean", "description": "Was the tier grandfathered from a previous program", "example": false }, { "name": "earned", "kind": "optional", "type": "boolean", "description": "Was the tier earned from program earning rules", "example": true }, { "name": "lifetime", "kind": "optional", "type": "boolean", "description": "Identifies if the tier is a lifetime tier. Lifetime tiers do not expire", "example": false }, { "name": "rolloverNights", "kind": "optional", "type": "integer", "description": "Number of nights over what was needed to qualify for this tier that will go towards qualification for a future tier.", "example": 10 }, { "name": "assignmentReason", "kind": "optional", "type": "string", "description": "Reason tier was awarded", "example": "bonus", "enum": [ "bonus", "creditcard", "management", "manual", "promotion", "stepdown", "system", "tiergift" ] }, { "name": "assignmentReasonObjectExternalReference", "kind": "optional", "type": "string", "description": "Identifier for the thing that caused this tier to be awarded" }, { "name": "assignmentReasonObjectDescription", "kind": "optional", "type": "string", "description": "Description for the thing that caused this tier to be awarded.", "example": "Adjustment Bonus 1000 Points" }, { "name": "createdBy", "kind": "optional", "type": "string", "description": "Identifier for the user that caused this tier to be awarded." }, { "name": "sourceCouponUse", "kind": "optional", "type": "object", "description": "Coupon and offer details for tiers awarded through a tier gift", "modelRef": "#/components/schemas/MemberTierCouponUse", "customType": "MemberTierCouponUse", "schema": [ { "name": "couponCode", "kind": "optional", "type": "string", "description": "Coupon code", "example": "113456816" }, { "name": "offerCode", "kind": "optional", "type": "string", "description": "Offer code associated with the coupon", "example": "Q1UP" }, { "name": "offerName", "kind": "optional", "type": "string", "description": "Name of the offer associated with the coupon", "example": "Q1 upgrades" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Earliest date the coupon is valid", "example": "2025-01-15", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Latest date the coupon is valid", "example": "2026-01-15", "format": "date" } ] } ] }, { "name": "addresses", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberAddress", "customType": "MemberAddress[]", "schema": [ { "name": "memberAddressId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member Address Id (null on create requests)

", "format": "int64" }, { "name": "address1", "kind": "optional", "type": "string", "description": "Line 1 of the member's physical address", "minLength": 0, "maxLength": 128 }, { "name": "address2", "kind": "optional", "type": "string", "description": "Optional line 2 of the member's physical address", "minLength": 0, "maxLength": 128 }, { "name": "address3", "kind": "optional", "type": "string", "description": "Optional line 3 of the member's physical address", "minLength": 0, "maxLength": 100 }, { "name": "city", "kind": "optional", "type": "string", "description": "Member's city of residence", "minLength": 0, "maxLength": 128 }, { "name": "stateCode", "kind": "optional", "type": "string", "description": "

State code as defined by the ISO-3166-2 principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.

" }, { "name": "zip", "kind": "optional", "type": "string", "description": "

Member's zip/postal code. Format: 12345

", "minLength": 0, "maxLength": 20 }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Classification of the physical address. Valid values: Home, Business.

" }, { "name": "countryCode", "kind": "required", "type": "string", "description": "

Member's country of residence. ISO 3166-1 Alpha-2 country code.

" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "Company name associated with the address", "minLength": 0, "maxLength": 100 }, { "name": "asciiAddress1", "kind": "optional", "type": "string", "description": "ASCII Address1. One will be generated if not provided. Only valid if enabled on Client program configuration.", "minLength": 0, "maxLength": 128 }, { "name": "asciiAddress2", "kind": "optional", "type": "string", "description": "ASCII Address2. One will be generated if not provided. Only valid if enabled on Client program configuration.", "minLength": 0, "maxLength": 128 }, { "name": "asciiAddress3", "kind": "optional", "type": "string", "description": "ASCII Address3. One will be generated if not provided. Only valid if enabled on Client program configuration.", "minLength": 0, "maxLength": 100 }, { "name": "asciiCity", "kind": "optional", "type": "string", "description": "ASCII City. One will be generated if not provided. Only valid if enabled on Client program configuration.", "minLength": 0, "maxLength": 128 }, { "name": "asciiStateCode", "kind": "optional", "type": "string", "description": "ASCII State Code. One will be generated if not provided. Only valid if enabled on Client program configuration." }, { "name": "asciiZip", "kind": "optional", "type": "string", "description": "ASCII Zip. One will be generated if not provided. Only valid if enabled on Client program configuration.", "minLength": 0, "maxLength": 20 }, { "name": "asciiCountryCode", "kind": "optional", "type": "string", "description": "ASCII Country Code. One will be generated if not provided. One will be generated if not provided. Only valid if enabled on Client program configuration.\n" }, { "name": "order", "kind": "optional", "type": "integer", "description": "

Priority / Order of the address. If not provided - will be set to default of 1 for create requests, and existing value for update requests. Upon member enrollment, if multiple addresses are provided, order will default to 1 unless another address in the request already has an order value of 1, in which case, order will be incremented by 1 until there is no matching order in the member's addresses.

", "format": "int32" }, { "name": "active", "kind": "optional", "type": "boolean", "description": "active" }, { "name": "validated", "kind": "optional", "type": "boolean", "description": "Has the address been validated" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "

Status of the address record. A = Active (address is current and valid), C = Closed/Inactive (address is no longer active).

", "minLength": 1, "maxLength": 50 }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "DateTime of the last time the address was updated", "format": "date-time" } ] }, { "name": "aliases", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberAlias", "customType": "MemberAlias[]", "schema": [ { "name": "memberAliasId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member Alias Id (null on create requests)

", "example": 12345, "format": "int64" }, { "name": "typeCode", "kind": "required", "type": "string", "description": "

Type of alias identifier for the member. Standard values: Email, Merge, Mobile, Card, ClientAccountNumber, LegacyAccountNumber, Partner. Additional client-defined values may be present depending on program configuration.

", "example": "Email" }, { "name": "alias", "kind": "required", "type": "string", "description": "The alias value", "example": "A123456", "minLength": 1, "maxLength": 200 }, { "name": "mergeMemberIdentifier", "kind": "optional", "type": "string", "description": "

Identifies the member whose account was merged (MergeSurvivor or MergeVictim)

" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "

Date the alias starts, will default to current date if not provided

", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Date the alias ends", "format": "date" }, { "name": "partnerProgramCode", "kind": "optional", "type": "string", "description": "Partner Program identifier the alias is associated. Used for PartnerPreferred Alias. Optional" }, { "name": "partnerProgramName", "kind": "optional", "type": "string", "readOnly": true, "description": "Partner Program name the alias is associated. Used for PartnerPreferred Alias. Optional" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "

Status of the alias - Valid values: Active, Inactive

", "default": "Active" }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "

Timestamp the alias was updated (null on create requests)

", "format": "date-time" } ] }, { "name": "currencies", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberCurrency", "customType": "MemberCurrency[]", "schema": [ { "name": "typeCode", "kind": "required", "type": "string", "description": "

Identifies type of currency - ie. Point vs. Mile

", "example": "POINTS" }, { "name": "typeCodeDescription", "kind": "optional", "type": "string", "description": "Currency type description", "example": "Points" }, { "name": "categoryCode", "kind": "required", "type": "string", "description": "Short identifier of currency category", "example": "P" }, { "name": "categoryCodeDescription", "kind": "optional", "type": "string", "description": "Currency category description", "example": "Loyalty" }, { "name": "expireType", "kind": "optional", "type": "string", "description": "

Identifies expiration type of Currency - ie. Incremental, LimitedTime, Rolling

", "example": "LimitedTime" }, { "name": "expireTypeDescription", "kind": "optional", "type": "string", "description": "Currency expiration description", "example": "Standard Expiration" }, { "name": "description", "kind": "optional", "type": "string", "description": "Member currency description" }, { "name": "available", "kind": "required", "type": "number", "description": "

Currency available to spend [Earned - (Expired + Redeemed)]

", "example": 675 }, { "name": "earned", "kind": "required", "type": "number", "description": "Amount of currency earned", "example": 1000 }, { "name": "redeemed", "kind": "required", "type": "number", "description": "Amount of currency redeemed", "example": 300 }, { "name": "expired", "kind": "required", "type": "number", "description": "Amount of currency expired", "example": 25 }, { "name": "changeDate", "kind": "optional", "type": "string", "description": "Date of last member currency change", "example": "2023-05-11", "format": "date" }, { "name": "pointForfeitureDate", "kind": "optional", "type": "string", "description": "

Date of point forfeiture, if any

", "example": "2023-05-11", "format": "date" }, { "name": "primaryCurrency", "kind": "optional", "type": "boolean", "description": "Indicates whether currency is primary currency as configured for program", "example": false, "default": false } ] }, { "name": "emails", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberEmail", "customType": "MemberEmail[]", "schema": [ { "name": "memberEmailId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member Email Id (null on create requests)

", "format": "int64" }, { "name": "email", "kind": "required", "type": "string", "description": "Email Address", "example": "email@email.com", "minLength": 0, "maxLength": 150 }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Classification of the email address. Valid values: Home, Work, Other.

" }, { "name": "order", "kind": "optional", "type": "integer", "description": "

Order. If not provided - will be set to default of 1 for create requests, and existing value for update requests. Upon member enrollment, if multiple emails are provided, order will default to 1 unless another email in the request already has an order value of 1, in which case, order will be incremented by 1 until there is no matching order in the member's emails.

", "example": 1, "format": "int32" }, { "name": "validated", "kind": "optional", "type": "boolean", "description": "Has the email address been validated" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "

Status of the email address. A = Active (address is valid and in use), C = Closed/Inactive (address is no longer active).

" }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "DateTime of the last time the email was updated", "format": "date-time" } ] }, { "name": "phones", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberPhone", "customType": "MemberPhone[]", "schema": [ { "name": "memberPhoneId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member Phone Id (null on create requests)

", "format": "int64" }, { "name": "phoneNumber", "kind": "required", "type": "string", "description": "Phone number value. Max length 25. Allows for a formated number when edited. The entered value will be stored in the rawPhoneNumber field and on reads the phoneNumber field returns a numeric phone number.\n", "example": "1 414 111-1111", "minLength": 0, "maxLength": 25, "pattern": "^([^0-9]*[0-9]){0,15}[^0-9]*$" }, { "name": "phoneExtension", "kind": "optional", "type": "string", "description": "Phone extension. Max length 10", "minLength": 0, "maxLength": 10 }, { "name": "rawPhoneNumber", "kind": "optional", "type": "string", "readOnly": true, "description": "Phone number value. Max length 75", "minLength": 0, "maxLength": 75 }, { "name": "carrier", "kind": "optional", "type": "string", "description": "

Phone carrier (phone company) name. Max length 10

" }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Classification of the phone number. Valid values: Home, Work, Mobile, Fax, None.

", "example": "Mobile" }, { "name": "smsCapable", "kind": "optional", "type": "boolean", "description": "Identifies if the phone number can receive and send SMS messages" }, { "name": "validated", "kind": "optional", "type": "boolean", "description": "Has the phone number been validated" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "

Status of the phone number. A = Active (number is valid and in use), C = Closed/Inactive (number is no longer active).

", "example": "A" }, { "name": "order", "kind": "optional", "type": "integer", "description": "

Phone order/preference ranking. Lower values indicate higher preference. For POST requests, if omitted, will be set to max(existing orders) + 1, or 1 if this is the first phone. For PUT requests, if omitted, existing value is preserved.

", "example": 1 }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "DateTime of the last time the phone number was updated", "format": "date-time" } ] }, { "name": "preferences", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/MemberPreference", "customType": "MemberPreference[]", "schema": [ { "name": "memberPreferenceId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member preference identifier (null on create requests)

", "format": "int64" }, { "name": "preferenceRuleCode", "kind": "required", "type": "string", "description": "

Preference rule code (IE: ROOM_PREFERENCE)

" }, { "name": "preferenceRuleDescription", "kind": "optional", "type": "string", "readOnly": true, "description": "

Preference rule description (null on create/update requests)

" }, { "name": "preferenceRuleDetailCode", "kind": "required", "type": "string", "description": "

Detail code (IE: ROOM_PREFERENCE_LOCATION, ROOM_PREFERENCE_BEDTYPE)

" }, { "name": "preferenceRuleDetailDescription", "kind": "optional", "type": "string", "readOnly": true, "description": "

Detail description (null on create/update requests)

" }, { "name": "preferenceTypeCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Preference value type" }, { "name": "preferenceDataType", "kind": "optional", "type": "string", "readOnly": true, "description": "Preference rule detail data type" }, { "name": "value", "kind": "optional", "type": "string", "description": "

The value of the member preference (IE: ELEVATOR, KING, etc)

" }, { "name": "description", "kind": "optional", "type": "string", "description": "Ace description or data code description " }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "DateTime of the last time the preference was updated", "format": "date-time" }, { "name": "updateUserId", "kind": "optional", "type": "integer", "readOnly": true, "description": "ID of the user who last updated this preference", "format": "int64" }, { "name": "updateUserName", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who last updated this preference" } ] }, { "name": "paymentCardAccounts", "kind": "optional", "type": "array", "description": "

Representation of a member's payment (credit) card. DO NOT ENTER PCI INFORMATION.

", "modelRef": "#/components/schemas/MemberPaymentCardAccount", "customType": "MemberPaymentCardAccount[]", "schema": [ { "name": "memberPaymentCardAccountId", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Member Payment Card Account Id (null on create requests)

", "format": "int64" }, { "name": "typeCode", "kind": "required", "type": "string", "description": "

Card Type: As defined by program configuration. Configure Program Setting: 'CreditCardType'.

", "minLength": 1, "maxLength": 50 }, { "name": "paymentCardAccountNumber", "kind": "required", "type": "string", "description": "

Account number associated to the payment card account, typically Acquirer Reference Number. DO NOT ENTER PCI INFORMATION.

", "minLength": 1, "maxLength": 50 }, { "name": "enrollmentDate", "kind": "optional", "type": "string", "description": "Date member was enrolled in the payment card program.", "format": "date" }, { "name": "lastOpenDate", "kind": "optional", "type": "string", "description": "Date member last opened the card in the program.", "format": "date" }, { "name": "lastClosedDate", "kind": "optional", "type": "string", "description": "Date member last closed the card in the program.", "format": "date" }, { "name": "firstUseDate", "kind": "optional", "type": "string", "description": "Date in which the card was first used", "format": "date" }, { "name": "accountStatusDate", "kind": "optional", "type": "string", "description": "Date in which the card status was changed. This is defined by the payment card partner.", "format": "date" }, { "name": "productType", "kind": "optional", "type": "string", "description": "Credit card product type code", "maxLength": 50 }, { "name": "productTypeDescription", "kind": "optional", "type": "string", "readOnly": true, "description": "

Human-readable description of the credit card product type.

" }, { "name": "sourceCode", "kind": "optional", "type": "string", "description": "Source that opened the card", "minLength": 1, "maxLength": 50 }, { "name": "merchantCode", "kind": "optional", "type": "string", "description": "Merchant that opened the card", "maxLength": 50 }, { "name": "channelCode", "kind": "optional", "type": "string", "description": "Channel that opened the card", "minLength": 1, "maxLength": 50 }, { "name": "firstName", "kind": "optional", "type": "string", "description": "Member first name as it appears with the card processor", "maxLength": 100 }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Member last name as it appears with the card processor", "maxLength": 100 }, { "name": "birthDate", "kind": "optional", "type": "string", "description": "Member's date of birth with the card processor", "format": "date" }, { "name": "updateDateTime", "kind": "optional", "type": "string", "readOnly": true, "description": "Timestamp the payment card account was updated.", "format": "date-time" }, { "name": "active", "kind": "optional", "type": "boolean", "readOnly": true, "description": "

True if lastClosedDate is null or before/equals to lastOpenDate

" }, { "name": "cardComment", "kind": "optional", "type": "string", "description": "Comment associated with the credit card account", "maxLength": 300 }, { "name": "additionalProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] }, { "name": "authorizedMembers", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/AuthorizedMember", "customType": "AuthorizedMember[]", "schema": [ { "name": "firstName", "kind": "optional", "type": "string", "description": "Member's first name", "minLength": 1, "maxLength": 100 }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Member's last name", "minLength": 1, "maxLength": 100 }, { "name": "email", "kind": "optional", "type": "string", "description": "Member's email", "example": "username@test.com" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Member's phone", "example": 12345 }, { "name": "order", "kind": "optional", "type": "integer", "description": "Delegate order", "example": 1 }, { "name": "authDelegateType", "kind": "optional", "type": "string", "description": "

Authorized delegate type e.g. AuthUser, Business, Emergency Contact or Secondary User

", "example": "A, B, E or S" } ] }, { "name": "lists", "kind": "optional", "type": "array", "description": "Represents a member in a member list", "modelRef": "#/components/schemas/ListMember", "customType": "ListMember[]", "schema": [ { "name": "memberIdentifier", "kind": "optional", "type": "string", "readOnly": true, "description": "Member identifier" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Date the member was or will be included in the member list", "example": "2020-04-06", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Date the member was or will be excluded from the member list", "example": "2026-04-02", "format": "date" }, { "name": "memberList", "kind": "optional", "type": "object", "description": "Defines a list of members", "modelRef": "#/components/schemas/MemberList", "customType": "MemberList", "schema": [ { "name": "memberListId", "kind": "optional", "type": "integer", "readOnly": true, "description": "Member list identifier", "format": "int64" }, { "name": "code", "kind": "optional", "type": "string", "description": "Code of member list" }, { "name": "name", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of member list" }, { "name": "description", "kind": "optional", "type": "string", "readOnly": true, "description": "Description of member list" }, { "name": "statusCode", "kind": "optional", "type": "string", "readOnly": true, "description": "

Status of the member list, one of: ACTIVE, INACTIVE

" }, { "name": "typeCode", "kind": "optional", "type": "string", "readOnly": true, "description": "

Type of the member list, one of: SEGMENT, LIMITED_TIME, TIER_ROLLOVER, OTHER, ...

" } ] } ] }, { "name": "LinkedAdminAccounts", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/LinkedAccount", "customType": "LinkedAccount[]", "schema": [ { "name": "memberIdentifier", "kind": "required", "type": "string", "description": "Unique identifier for the linked member account.", "example": "500000003B" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Account number for the linked member account.", "example": "500000003B" }, { "name": "firstName", "kind": "optional", "type": "string", "description": "First name of the linked account." }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Last name of the linked account." }, { "name": "companyName", "kind": "optional", "type": "string", "description": "Company name of the linked account." }, { "name": "linkedType", "kind": "required", "type": "string", "description": "

Type of link to the member account (e.g., \"Corp\" for corporate).

", "example": "Corp" }, { "name": "administrator", "kind": "optional", "type": "boolean", "description": "", "example": true, "default": false } ] }, { "name": "linkedAccounts", "kind": "optional", "type": "array", "description": "

Accounts this member is linked to. Only populated when includeLinkedAccounts=true.

", "modelRef": "#/components/schemas/LinkedAccount", "customType": "LinkedAccount[]", "schema": [ { "name": "memberIdentifier", "kind": "required", "type": "string", "description": "Unique identifier for the linked member account.", "example": "500000003B" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Account number for the linked member account.", "example": "500000003B" }, { "name": "firstName", "kind": "optional", "type": "string", "description": "First name of the linked account." }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Last name of the linked account." }, { "name": "companyName", "kind": "optional", "type": "string", "description": "Company name of the linked account." }, { "name": "linkedType", "kind": "required", "type": "string", "description": "

Type of link to the member account (e.g., \"Corp\" for corporate).

", "example": "Corp" }, { "name": "administrator", "kind": "optional", "type": "boolean", "description": "", "example": true, "default": false } ] } ], "modelRef": "#/components/schemas/MemberProfile", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "List of errors", "modelRef": "#/components/schemas/ValidationError", "customType": "ValidationError[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code assigned to this violation" }, { "name": "fieldName", "kind": "optional", "type": "string", "description": "

Name of field that violated validation constraint (optional)

" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "8lestpvx26H9uEDuz1HOl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.b.preview.loyaltyservices.io/api/v3/members?includeReversedName=boolean&includeOnlyDisplayableLists=boolean&includeInactive=boolean' \\\n --header 'accept: application/json'" }, { "id": "oVCvtduoKSs70f5rynNJF", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/members?includeReversedName=boolean&includeOnlyDisplayableLists=boolean&includeInactive=boolean\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "kStV06Te-Z0cz0hvAjxp7", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/members?includeReversedName=boolean&includeOnlyDisplayableLists=boolean&includeInactive=boolean\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "UybZK-7FiCsNkpQx1Idtm", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/members?includeReversedName=boolean&includeOnlyDisplayableLists=boolean&includeInactive=boolean\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "8lestpvx26H9uEDuz1HOl" }, "results": { "languages": [ { "id": "jE29iS1_2QiK_cZahpFzH", "language": "200", "code": "// Success\n[\n {\n \"memberIdentifier\": \"\",\n \"accountNumber\": \"\",\n \"mergeSurvivorMemberIdentifier\": \"\",\n \"mergeSurvivorAccountNumber\": \"\",\n \"accountTypeCode\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"suffix\": \"\",\n \"birthDate\": \"\",\n \"enrollmentCode\": \"\",\n \"enrollmentDateTime\": \"\",\n \"enrollmentDeviceTypeCode\": \"\",\n \"enrollmentLocation\": \"\",\n \"enrollmentEmployee\": \"\",\n \"enrollmentSourceCode\": \"\",\n \"accountStatusCode\": \"\",\n \"accountStatusCodeDescription\": \"\",\n \"accountStatusUpdateDateTime\": \"\",\n \"accountStatusUpdateUser\": \"\",\n \"closedReasonCode\": \"\",\n \"closedStatusComment\": \"\",\n \"closedDate\": \"\",\n \"companyName\": \"\",\n \"genderCode\": \"\",\n \"language\": \"\",\n \"testAccount\": false,\n \"scrubbed\": false,\n \"onlineActivationDateTime\": \"\",\n \"updateDateTime\": \"\",\n \"asciiFirstName\": \"\",\n \"asciiMiddleName\": \"\",\n \"asciiNickName\": \"\",\n \"asciiLastName\": \"\",\n \"asciiSuffix\": \"\",\n \"asciiTitle\": \"\",\n \"asciiLanguage\": \"\",\n \"closeable\": {\n \"closeable\": false,\n \"code\": \"12001\",\n \"reason\": \"Member has negative point balance and cannot be closed or merged.\"\n },\n \"currentTier\": {\n \"tierCode\": \"B\",\n \"description\": \"Base\",\n \"rank\": 10,\n \"typeCode\": \"Earned\",\n \"startDate\": \"2020-01-01\",\n \"endDate\": \"2020-12-31\",\n \"grandFathered\": false,\n \"earned\": true,\n \"lifetime\": false,\n \"rolloverNights\": 10,\n \"assignmentReason\": \"bonus\",\n \"assignmentReasonObjectExternalReference\": \"\",\n \"assignmentReasonObjectDescription\": \"Adjustment Bonus 1000 Points\",\n \"createdBy\": \"\",\n \"sourceCouponUse\": {\n \"couponCode\": \"113456816\",\n \"offerCode\": \"Q1UP\",\n \"offerName\": \"Q1 upgrades\",\n \"startDate\": \"2025-01-15\",\n \"endDate\": \"2026-01-15\"\n }\n },\n \"addresses\": [\n {\n \"memberAddressId\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"stateCode\": \"\",\n \"zip\": \"\",\n \"typeCode\": \"\",\n \"countryCode\": \"\",\n \"companyName\": \"\",\n \"asciiAddress1\": \"\",\n \"asciiAddress2\": \"\",\n \"asciiAddress3\": \"\",\n \"asciiCity\": \"\",\n \"asciiStateCode\": \"\",\n \"asciiZip\": \"\",\n \"asciiCountryCode\": \"\",\n \"order\": \"\",\n \"active\": false,\n \"validated\": false,\n \"statusCode\": \"\",\n \"updateDateTime\": \"\"\n }\n ],\n \"aliases\": [\n {\n \"memberAliasId\": 12345,\n \"typeCode\": \"Email\",\n \"alias\": \"A123456\",\n \"mergeMemberIdentifier\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"partnerProgramCode\": \"\",\n \"partnerProgramName\": \"\",\n \"statusCode\": \"\",\n \"updateDateTime\": \"\"\n }\n ],\n \"currencies\": [\n {\n \"typeCode\": \"POINTS\",\n \"typeCodeDescription\": \"Points\",\n \"categoryCode\": \"P\",\n \"categoryCodeDescription\": \"Loyalty\",\n \"expireType\": \"LimitedTime\",\n \"expireTypeDescription\": \"Standard Expiration\",\n \"description\": \"\",\n \"available\": 675,\n \"earned\": 1000,\n \"redeemed\": 300,\n \"expired\": 25,\n \"changeDate\": \"2023-05-11\",\n \"pointForfeitureDate\": \"2023-05-11\",\n \"primaryCurrency\": false\n }\n ],\n \"emails\": [\n {\n \"memberEmailId\": \"\",\n \"email\": \"email@email.com\",\n \"typeCode\": \"\",\n \"order\": 1,\n \"validated\": false,\n \"statusCode\": \"\",\n \"updateDateTime\": \"\"\n }\n ],\n \"phones\": [\n {\n \"memberPhoneId\": \"\",\n \"phoneNumber\": \"1 414 111-1111\",\n \"phoneExtension\": \"\",\n \"rawPhoneNumber\": \"\",\n \"carrier\": \"\",\n \"typeCode\": \"Mobile\",\n \"smsCapable\": false,\n \"validated\": false,\n \"statusCode\": \"A\",\n \"order\": 1,\n \"updateDateTime\": \"\"\n }\n ],\n \"preferences\": [\n {\n \"memberPreferenceId\": \"\",\n \"preferenceRuleCode\": \"\",\n \"preferenceRuleDescription\": \"\",\n \"preferenceRuleDetailCode\": \"\",\n \"preferenceRuleDetailDescription\": \"\",\n \"preferenceTypeCode\": \"\",\n \"preferenceDataType\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"updateDateTime\": \"\",\n \"updateUserId\": \"\",\n \"updateUserName\": \"\"\n }\n ],\n \"paymentCardAccounts\": [\n {\n \"memberPaymentCardAccountId\": \"\",\n \"typeCode\": \"\",\n \"paymentCardAccountNumber\": \"\",\n \"enrollmentDate\": \"\",\n \"lastOpenDate\": \"\",\n \"lastClosedDate\": \"\",\n \"firstUseDate\": \"\",\n \"accountStatusDate\": \"\",\n \"productType\": \"\",\n \"productTypeDescription\": \"\",\n \"sourceCode\": \"\",\n \"merchantCode\": \"\",\n \"channelCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"updateDateTime\": \"\",\n \"active\": false,\n \"cardComment\": \"\",\n \"additionalProperties\": {}\n }\n ],\n \"authorizedMembers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"username@test.com\",\n \"phone\": 12345,\n \"order\": 1,\n \"authDelegateType\": \"A, B, E or S\"\n }\n ],\n \"lists\": [\n {\n \"memberIdentifier\": \"\",\n \"startDate\": \"2020-04-06\",\n \"endDate\": \"2026-04-02\",\n \"memberList\": {\n \"memberListId\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"statusCode\": \"\",\n \"typeCode\": \"\"\n }\n }\n ],\n \"LinkedAdminAccounts\": [\n {\n \"memberIdentifier\": \"500000003B\",\n \"accountNumber\": \"500000003B\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"linkedType\": \"Corp\",\n \"administrator\": true\n }\n ],\n \"linkedAccounts\": [\n {\n \"memberIdentifier\": \"500000003B\",\n \"accountNumber\": \"500000003B\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"linkedType\": \"Corp\",\n \"administrator\": true\n }\n ]\n }\n]" }, { "id": "fEh-q1VV0HRFfxDaE_4DA", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "JMLWKNXiHSvbGc_WCS656", "language": "401", "code": "// Unauthorized\n" }, { "id": "NT4h2bEHqqXUOYn47jZ3f", "language": "403", "code": "// Forbidden\n" }, { "id": "YG2P97JY-gFxjJ_0zrZx4", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "jE29iS1_2QiK_cZahpFzH" } }, "children": [ { "text": "" } ] }