Create Member badge
1 min
POST
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/badges/{badgeId}
Path Parameters
- memberIdentifierstringrequiredDescriptionMin Length1Max Length200
- badgeIdinteger<int64>requiredDescriptionFormatint64
Body Parameters
- bodyCreateMemberBadgeRequestrequired
- commentstringrequiredDescription
Responses
200
- MemberBadge
- memberBadgeIdinteger<int64>ExampleDescriptionFormatint64
- badgeDetailsBadgeDataDescription
- badgeIdinteger<int64>ExampleDescriptionFormatint64
- badgeTypeCodestringExampleDescription
- badgeNamestringExampleDescription
- badgeDescriptionstringExampleDescription
- statusCodestringExampleDescription
- expirationDatestring<date>ExampleDescriptionFormatdate
- expirationTypestringExampleDescription
- expirationDayPeriodinteger<int32>ExampleDescriptionFormatint32
- expirationTimePeriodinteger<int32>ExampleDescriptionFormatint32
- logoKeystringExampleDescription
- contentGenericItem
- contentCodestringrequiredExampleDescription
- contentTypeCodestringExampleDescription
- namestringExampleDescriptionMax Length50
- shortDescriptionstringExampleDescriptionMax Length500
- descriptionstringExampleDescription
- alternateDescriptionstringExampleDescription
- termsAndConditionsstringExampleDescription
- titlestringExampleDescriptionMax Length200
- labelstringExampleDescriptionMax Length255
- logoKeystringExampleDescription
- displayTypeKeystringExampleDescription
- startDatestring<date-time>DescriptionFormatdate-time
- endDatestring<date-time>DescriptionFormatdate-time
- urlstringExampleDescriptionMax Length1000
- tierCodestringExampleDescription
- displayForAllbooleanExampleDescription
- descriptorCodestringExampleDescription
- sourcecodestringExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- updateUserNamestringDescription
- createUserNamestringDescription
- sourceDescriptionstringDescription
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/{memberIdentifier}/badges/{badgeId} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"comment": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"comment": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/badges/{badgeId}", 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/{memberIdentifier}/badges/{badgeId}")
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({
"comment": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/badges/{badgeId}"
payload = json.dumps({
"comment": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"memberBadgeId": 147258369,
"badgeDetails": {
"badgeId": 147258369,
"badgeTypeCode": "General",
"badgeName": "Event Organizer",
"badgeDescription": "An organizer who brings in over $100,000 year in business",
"statusCode": "Active",
"expirationDate": "4000-01-01",
"expirationType": "Exact",
"expirationDayPeriod": 60,
"expirationTimePeriod": 10,
"logoKey": "elite-explorer.png",
"content": {
"contentCode": "Bonus100",
"contentTypeCode": "HEADER",
"name": "Bonus 100 points",
"shortDescription": "Award 100 points",
"description": "Award 100 points on 100th stay",
"alternateDescription": "Award 100 points on 100th stay",
"termsAndConditions": "Terms and conditions for this promotion",
"title": "Award 100 points",
"label": "100 points awarded",
"logoKey": "100-points.png",
"displayTypeKey": "100 points",
"startDate": "",
"endDate": "",
"url": "/loyaltyprogram/bonus/100-points",
"tierCode": "B",
"displayForAll": true,
"descriptorCode": "LIMITED_TIME"
}
},
"sourcecode": "Promotion",
"statusCode": "Activated",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"updateUserName": "",
"createUserName": "",
"sourceDescription": ""
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error