Enroll Member
1 min
POST
https://api.b.preview.loyaltyservices.io/api/v3/members
Query Parameters
- migratebooleanDescriptionDefaultfalse
- asyncbooleanDescriptionDefaultfalse
Body Parameters
- bodyMemberEnrollRequestrequiredDescription
- memberIdentifierstringDescriptionMin Length1Max Length200
- accountNumberstringDescriptionMin Length7Max Length25
- accountTypeCodestringExampleDescriptionDefaultMBR
- titlestringDescriptionMin Length0Max Length100
- firstNamestringDescriptionMin Length1Max Length100
- middleNamestringDescriptionMin Length0Max Length100
- lastNamestringDescriptionMin Length1Max Length100
- suffixstringDescription
- birthDatestring<date>DescriptionFormatdate
- enrollmentCodestringDescription
- enrollmentDateTimestring<date-time>DescriptionFormatdate-time
- enrollmentDeviceTypeCodestringDescription
- enrollmentLocationstringDescriptionMin Length0Max Length50
- enrollmentEmployeestringDescriptionMin Length0Max Length50
- enrollmentSourceCodestringDescription
- accountStatusCodestringDescription
- companyNamestringDescriptionMin Length1Max Length100
- genderCodestringDescription
- languagestringDescription
- onlineActivationDateTimestring<date-time>DescriptionFormatdate-time
- testAccountbooleanDescription
- asciiFirstNamestringDescription
- asciiMiddleNamestringDescription
- asciiNickNamestringDescription
- asciiLastNamestringDescription
- asciiSuffixstringDescription
- asciiTitlestringDescription
- asciiLanguagestringDescription
- linkedAccountsLinkedAccount[]Description
- memberIdentifierstringrequiredExampleDescription
- accountNumberstringExampleDescription
- firstNamestringDescription
- lastNamestringDescription
- companyNamestringDescription
- linkedTypestringrequiredExampleDescription
- administratorbooleanExampleDefaultfalse
- addressesMemberAddress[]Description
- memberAddressIdinteger<int64>DescriptionFormatint64
- address1stringDescriptionMin Length0Max Length128
- address2stringDescriptionMin Length0Max Length128
- address3stringDescriptionMin Length0Max Length100
- citystringDescriptionMin Length0Max Length128
- stateCodestringDescription
- zipstringDescriptionMin Length0Max Length20
- typeCodestringDescription
- countryCodestringrequiredDescription
- companyNamestringDescriptionMin Length0Max Length100
- asciiAddress1stringDescriptionMin Length0Max Length128
- asciiAddress2stringDescriptionMin Length0Max Length128
- asciiAddress3stringDescriptionMin Length0Max Length100
- asciiCitystringDescriptionMin Length0Max Length128
- asciiStateCodestringDescription
- asciiZipstringDescriptionMin Length0Max Length20
- asciiCountryCodestringDescription
- orderinteger<int32>DescriptionFormatint32
- activebooleanDescription
- validatedbooleanDescription
- statusCodestringDescriptionMin Length1Max Length50
- updateDateTimestring<date-time>DescriptionFormatdate-time
- emailsMemberEmail[]Description
- memberEmailIdinteger<int64>DescriptionFormatint64
- emailstringrequiredExampleDescriptionMin Length0Max Length150
- typeCodestringDescription
- orderinteger<int32>ExampleDescriptionFormatint32
- validatedbooleanDescription
- statusCodestringDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- phonesMemberPhone[]Description
- memberPhoneIdinteger<int64>DescriptionFormatint64
- phoneNumberstringrequiredExampleDescriptionMin Length0Max Length25Pattern^([^0-9]*[0-9]){0,15}[^0-9]*$
- phoneExtensionstringDescriptionMin Length0Max Length10
- rawPhoneNumberstringDescriptionMin Length0Max Length75
- carrierstringDescription
- typeCodestringExampleDescription
- smsCapablebooleanDescription
- validatedbooleanDescription
- statusCodestringExampleDescription
- orderintegerExampleDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- preferencesMemberPreference[]Description
- memberPreferenceIdinteger<int64>DescriptionFormatint64
- preferenceRuleCodestringrequiredDescription
- preferenceRuleDescriptionstringDescription
- preferenceRuleDetailCodestringrequiredDescription
- preferenceRuleDetailDescriptionstringDescription
- preferenceTypeCodestringDescription
- preferenceDataTypestringDescription
- valuestringDescription
- descriptionstringDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- updateUserIdinteger<int64>DescriptionFormatint64
- updateUserNamestringDescription
- paymentCardsMemberPaymentCardAccount[]Description
- memberPaymentCardAccountIdinteger<int64>DescriptionFormatint64
- typeCodestringrequiredDescriptionMin Length1Max Length50
- paymentCardAccountNumberstringrequiredDescriptionMin Length1Max Length50
- enrollmentDatestring<date>DescriptionFormatdate
- lastOpenDatestring<date>DescriptionFormatdate
- lastClosedDatestring<date>DescriptionFormatdate
- firstUseDatestring<date>DescriptionFormatdate
- accountStatusDatestring<date>DescriptionFormatdate
- productTypestringDescriptionMax Length50
- sourceCodestringDescriptionMin Length1Max Length50
- merchantCodestringDescriptionMax Length50
- channelCodestringDescriptionMin Length1Max Length50
- firstNamestringDescriptionMax Length100
- lastNamestringDescriptionMax Length100
- birthDatestring<date>DescriptionFormatdate
- updateDateTimestring<date-time>DescriptionFormatdate-time
- activebooleanDescription
- cardCommentstringDescriptionMax Length300
- additionalPropertiesobject
- aliasesMemberAlias[]Description
- memberAliasIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- aliasstringrequiredExampleDescriptionMin Length1Max Length200
- mergeMemberIdentifierstringDescription
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- partnerProgramCodestringDescription
- partnerProgramNamestringDescription
- statusCodestringDescriptionDefaultActive
- updateDateTimestring<date-time>DescriptionFormatdate-time
- listsListMember[]Description
- memberIdentifierstringDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- memberListMemberListDescription
- memberListIdinteger<int64>DescriptionFormatint64
- codestringDescription
- namestringDescription
- descriptionstringDescription
- statusCodestringDescription
- typeCodestringDescription
- referralTypestringExampleDescription
- referralValuestringExampleDescription
- closedReasonCodestringDescription
Responses
200
- MemberEnrollResponse
- memberIdentifierstringDescriptionMin Length1Max Length200
- accountNumberstringDescriptionMin Length7Max Length25
- linkedAccountLinkedAccount[]
- memberIdentifierstringrequiredExampleDescription
- accountNumberstringExampleDescription
- firstNamestringDescription
- lastNamestringDescription
- companyNamestringDescription
- linkedTypestringrequiredExampleDescription
- administratorbooleanExampleDefaultfalse
- addressesMemberAddress[]Description
- memberAddressIdinteger<int64>DescriptionFormatint64
- address1stringDescriptionMin Length0Max Length128
- address2stringDescriptionMin Length0Max Length128
- address3stringDescriptionMin Length0Max Length100
- citystringDescriptionMin Length0Max Length128
- stateCodestringDescription
- zipstringDescriptionMin Length0Max Length20
- typeCodestringDescription
- countryCodestringrequiredDescription
- companyNamestringDescriptionMin Length0Max Length100
- asciiAddress1stringDescriptionMin Length0Max Length128
- asciiAddress2stringDescriptionMin Length0Max Length128
- asciiAddress3stringDescriptionMin Length0Max Length100
- asciiCitystringDescriptionMin Length0Max Length128
- asciiStateCodestringDescription
- asciiZipstringDescriptionMin Length0Max Length20
- asciiCountryCodestringDescription
- orderinteger<int32>DescriptionFormatint32
- activebooleanDescription
- validatedbooleanDescription
- statusCodestringDescriptionMin Length1Max Length50
- updateDateTimestring<date-time>DescriptionFormatdate-time
- emailsMemberEmail[]Description
- memberEmailIdinteger<int64>DescriptionFormatint64
- emailstringrequiredExampleDescriptionMin Length0Max Length150
- typeCodestringDescription
- orderinteger<int32>ExampleDescriptionFormatint32
- validatedbooleanDescription
- statusCodestringDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- phonesMemberPhone[]Description
- memberPhoneIdinteger<int64>DescriptionFormatint64
- phoneNumberstringrequiredExampleDescriptionMin Length0Max Length25Pattern^([^0-9]*[0-9]){0,15}[^0-9]*$
- phoneExtensionstringDescriptionMin Length0Max Length10
- rawPhoneNumberstringDescriptionMin Length0Max Length75
- carrierstringDescription
- typeCodestringExampleDescription
- smsCapablebooleanDescription
- validatedbooleanDescription
- statusCodestringExampleDescription
- orderintegerExampleDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- preferencesMemberPreference[]Description
- memberPreferenceIdinteger<int64>DescriptionFormatint64
- preferenceRuleCodestringrequiredDescription
- preferenceRuleDescriptionstringDescription
- preferenceRuleDetailCodestringrequiredDescription
- preferenceRuleDetailDescriptionstringDescription
- preferenceTypeCodestringDescription
- preferenceDataTypestringDescription
- valuestringDescription
- descriptionstringDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- updateUserIdinteger<int64>DescriptionFormatint64
- updateUserNamestringDescription
- aliasesMemberAlias[]Description
- memberAliasIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- aliasstringrequiredExampleDescriptionMin Length1Max Length200
- mergeMemberIdentifierstringDescription
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- partnerProgramCodestringDescription
- partnerProgramNamestringDescription
- statusCodestringDescriptionDefaultActive
- updateDateTimestring<date-time>DescriptionFormatdate-time
- paymentCardsMemberPaymentCardAccount[]Description
- memberPaymentCardAccountIdinteger<int64>DescriptionFormatint64
- typeCodestringrequiredDescriptionMin Length1Max Length50
- paymentCardAccountNumberstringrequiredDescriptionMin Length1Max Length50
- enrollmentDatestring<date>DescriptionFormatdate
- lastOpenDatestring<date>DescriptionFormatdate
- lastClosedDatestring<date>DescriptionFormatdate
- firstUseDatestring<date>DescriptionFormatdate
- accountStatusDatestring<date>DescriptionFormatdate
- productTypestringDescriptionMax Length50
- sourceCodestringDescriptionMin Length1Max Length50
- merchantCodestringDescriptionMax Length50
- channelCodestringDescriptionMin Length1Max Length50
- firstNamestringDescriptionMax Length100
- lastNamestringDescriptionMax Length100
- birthDatestring<date>DescriptionFormatdate
- updateDateTimestring<date-time>DescriptionFormatdate-time
- activebooleanDescription
- cardCommentstringDescriptionMax Length300
- additionalPropertiesobject
- currentTierMemberTier
- tierCodestringrequiredExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- rankinteger<int32>requiredExampleDescriptionFormatint32
- typeCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- grandFatheredbooleanDescription
- earnedbooleanExampleDescription
- lifetimebooleanDescription
- rolloverNightsintegerExampleDescription
- assignmentReasonstring<bonus | creditcard | management | manual | promotion | stepdown | system | tiergift>ExampleDescriptionAllowedbonuscreditcardmanagementmanualpromotionstepdownsystemtiergift
- assignmentReasonObjectExternalReferencestringDescription
- assignmentReasonObjectDescriptionstringExampleDescription
- createdBystringDescription
- sourceCouponUseMemberTierCouponUseDescription
- couponCodestringExampleDescription
- offerCodestringExampleDescription
- offerNamestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- listsListMember[]Description
- memberIdentifierstringDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- memberListMemberListDescription
- memberListIdinteger<int64>DescriptionFormatint64
- codestringDescription
- namestringDescription
- descriptionstringDescription
- statusCodestringDescription
- typeCodestringDescription
202
- AsyncTask
- asyncTaskIdinteger<int64>Formatint64
- taskTypeCodestringExampleDescription
- taskCodestringExampleDescription
- requestDatestring<date-time>DescriptionFormatdate-time
- requestDataobjectDescription
- statusCodestringDescription
- responseDatestring<date-time>DescriptionFormatdate-time
- responseDataobjectDescription
- fileNamestringDescription
- lineNumberintegerDescription
- fileDatastringDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request POST \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/members?migrate=boolean&async=boolean' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
"accountTypeCode": "MBR",
"linkedAccounts": [
{
"memberIdentifier": "500000003B",
"linkedType": "Corp"
}
],
"addresses": [
{
"countryCode": ""
}
],
"emails": [
{
"email": "[email protected]"
}
],
"phones": [
{
"phoneNumber": "1 414 111-1111"
}
],
"preferences": [
{
"preferenceRuleCode": "",
"preferenceRuleDetailCode": ""
}
],
"paymentCards": [
{
"typeCode": "",
"paymentCardAccountNumber": ""
}
],
"aliases": [
{
"typeCode": "Email",
"alias": "A123456",
"statusCode": "Active"
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"accountTypeCode": "MBR",
"linkedAccounts": [
{
"memberIdentifier": "500000003B",
"linkedType": "Corp"
}
],
"addresses": [
{
"countryCode": ""
}
],
"emails": [
{
"email": "[email protected]"
}
],
"phones": [
{
"phoneNumber": "1 414 111-1111"
}
],
"preferences": [
{
"preferenceRuleCode": "",
"preferenceRuleDetailCode": ""
}
],
"paymentCards": [
{
"typeCode": "",
"paymentCardAccountNumber": ""
}
],
"aliases": [
{
"typeCode": "Email",
"alias": "A123456",
"statusCode": "Active"
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/members?migrate=boolean&async=boolean", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/members?migrate=boolean&async=boolean")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"accountTypeCode": "MBR",
"linkedAccounts": [
{
"memberIdentifier": "500000003B",
"linkedType": "Corp"
}
],
"addresses": [
{
"countryCode": ""
}
],
"emails": [
{
"email": "[email protected]"
}
],
"phones": [
{
"phoneNumber": "1 414 111-1111"
}
],
"preferences": [
{
"preferenceRuleCode": "",
"preferenceRuleDetailCode": ""
}
],
"paymentCards": [
{
"typeCode": "",
"paymentCardAccountNumber": ""
}
],
"aliases": [
{
"typeCode": "Email",
"alias": "A123456",
"statusCode": "Active"
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members?migrate=boolean&async=boolean"
payload = json.dumps({
"accountTypeCode": "MBR",
"linkedAccounts": [
{
"memberIdentifier": "500000003B",
"linkedType": "Corp"
}
],
"addresses": [
{
"countryCode": ""
}
],
"emails": [
{
"email": "[email protected]"
}
],
"phones": [
{
"phoneNumber": "1 414 111-1111"
}
],
"preferences": [
{
"preferenceRuleCode": "",
"preferenceRuleDetailCode": ""
}
],
"paymentCards": [
{
"typeCode": "",
"paymentCardAccountNumber": ""
}
],
"aliases": [
{
"typeCode": "Email",
"alias": "A123456",
"statusCode": "Active"
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"memberIdentifier": "",
"accountNumber": "",
"linkedAccount": [
{
"memberIdentifier": "500000003B",
"accountNumber": "500000003B",
"firstName": "",
"lastName": "",
"companyName": "",
"linkedType": "Corp",
"administrator": true
}
],
"addresses": [
{
"memberAddressId": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"stateCode": "",
"zip": "",
"typeCode": "",
"countryCode": "",
"companyName": "",
"asciiAddress1": "",
"asciiAddress2": "",
"asciiAddress3": "",
"asciiCity": "",
"asciiStateCode": "",
"asciiZip": "",
"asciiCountryCode": "",
"order": "",
"active": false,
"validated": false,
"statusCode": "",
"updateDateTime": ""
}
],
"emails": [
{
"memberEmailId": "",
"email": "[email protected]",
"typeCode": "",
"order": 1,
"validated": false,
"statusCode": "",
"updateDateTime": ""
}
],
"phones": [
{
"memberPhoneId": "",
"phoneNumber": "1 414 111-1111",
"phoneExtension": "",
"rawPhoneNumber": "",
"carrier": "",
"typeCode": "Mobile",
"smsCapable": false,
"validated": false,
"statusCode": "A",
"order": 1,
"updateDateTime": ""
}
],
"preferences": [
{
"memberPreferenceId": "",
"preferenceRuleCode": "",
"preferenceRuleDescription": "",
"preferenceRuleDetailCode": "",
"preferenceRuleDetailDescription": "",
"preferenceTypeCode": "",
"preferenceDataType": "",
"value": "",
"description": "",
"updateDateTime": "",
"updateUserId": "",
"updateUserName": ""
}
],
"aliases": [
{
"memberAliasId": 12345,
"typeCode": "Email",
"alias": "A123456",
"mergeMemberIdentifier": "",
"startDate": "",
"endDate": "",
"partnerProgramCode": "",
"partnerProgramName": "",
"statusCode": "",
"updateDateTime": ""
}
],
"paymentCards": [
{
"memberPaymentCardAccountId": "",
"typeCode": "",
"paymentCardAccountNumber": "",
"enrollmentDate": "",
"lastOpenDate": "",
"lastClosedDate": "",
"firstUseDate": "",
"accountStatusDate": "",
"productType": "",
"sourceCode": "",
"merchantCode": "",
"channelCode": "",
"firstName": "",
"lastName": "",
"birthDate": "",
"updateDateTime": "",
"active": false,
"cardComment": "",
"additionalProperties": {}
}
],
"currentTier": {
"tierCode": "B",
"description": "Base",
"rank": 10,
"typeCode": "Earned",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"grandFathered": false,
"earned": true,
"lifetime": false,
"rolloverNights": 10,
"assignmentReason": "bonus",
"assignmentReasonObjectExternalReference": "",
"assignmentReasonObjectDescription": "Adjustment Bonus 1000 Points",
"createdBy": "",
"sourceCouponUse": {
"couponCode": "113456816",
"offerCode": "Q1UP",
"offerName": "Q1 upgrades",
"startDate": "2025-01-15",
"endDate": "2026-01-15"
}
},
"lists": [
{
"memberIdentifier": "",
"startDate": "2020-04-06",
"endDate": "2026-04-02",
"memberList": {
"memberListId": "",
"code": "",
"name": "",
"description": "",
"statusCode": "",
"typeCode": ""
}
}
]
}202
// Accepted
{
"asyncTaskId": "",
"taskTypeCode": "PlatformAPI",
"taskCode": "enrollMember",
"requestDate": "",
"requestData": {},
"statusCode": "",
"responseDate": "",
"responseData": {},
"fileName": "",
"lineNumber": 0,
"fileData": ""
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error