Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "profileDetails": {
# "customer": {
# "personName": [
# {
# "givenName": "James",
# "surname": "Smith",
# "nameType": "Primary"
# },
# {
# "nameType": "Alternate"
# },
# {
# "nameType": "Incognito"
# }
# ],
# "alienInfo": {},
# "birthCountry": {
# "code": ""
# },
# "language": "E"
# },
# "addresses": {
# "addressInfo": [
# {
# "address": {
# "isValidated": false,
# "addressLine": [
# "3450 North Triumph Boulevard",
# "Suite 300",
# "",
# ""
# ],
# "cityName": "Lehi",
# "postalCode": "84043",
# "state": "UT",
# "country": {
# "value": "US"
# },
# "language": "E",
# "type": "BUSINESS",
# "primaryInd": true
# }
# }
# ]
# },
# "telephones": {
# "telephoneInfo": [
# {
# "telephone": {
# "phoneTechType": "PHONE",
# "phoneUseType": "HOME",
# "phoneNumber": "+1 385 555 0102",
# "orderSequence": "1",
# "primaryInd": true
# }
# }
# ]
# },
# "mailingActions": {
# "active": true
# },
# "privacyInfo": {
# "marketResearchParticipation": true,
# "infoFromThirdParty": true,
# "autoEnrollLoyaltyProgram": false,
# "allowPhone": true,
# "allowSMS": true,
# "allowEmail": true,
# "optInMailingList": true,
# "optInMarketResearch": true,
# "optInThirdParty": true,
# "optInAutoEnrollmentMember": true,
# "optInPhone": true,
# "optInSms": true,
# "optInEmail": true
# },
# "taxInfo": {},
# "statusCode": "Active",
# "requestForHotel": "{{HotelId}}",
# "markAsRecentlyAccessed": true,
# "profileType": "Guest"
# },
# "profileIdList": [
# ]
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("profileDetails.customer.personName[0].givenName","James")
json.UpdateString("profileDetails.customer.personName[0].surname","Smith")
json.UpdateString("profileDetails.customer.personName[0].nameType","Primary")
json.UpdateString("profileDetails.customer.personName[1].nameType","Alternate")
json.UpdateString("profileDetails.customer.personName[2].nameType","Incognito")
json.UpdateNewObject("profileDetails.customer.alienInfo")
json.UpdateString("profileDetails.customer.birthCountry.code","")
json.UpdateString("profileDetails.customer.language","E")
json.UpdateBool("profileDetails.addresses.addressInfo[0].address.isValidated",false)
json.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[0]","3450 North Triumph Boulevard")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[1]","Suite 300")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[2]","")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[3]","")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.cityName","Lehi")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.postalCode","84043")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.state","UT")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.country.value","US")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.language","E")
json.UpdateString("profileDetails.addresses.addressInfo[0].address.type","BUSINESS")
json.UpdateBool("profileDetails.addresses.addressInfo[0].address.primaryInd",true)
json.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneTechType","PHONE")
json.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneUseType","HOME")
json.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneNumber","+1 385 555 0102")
json.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.orderSequence","1")
json.UpdateBool("profileDetails.telephones.telephoneInfo[0].telephone.primaryInd",true)
json.UpdateBool("profileDetails.mailingActions.active",true)
json.UpdateBool("profileDetails.privacyInfo.marketResearchParticipation",true)
json.UpdateBool("profileDetails.privacyInfo.infoFromThirdParty",true)
json.UpdateBool("profileDetails.privacyInfo.autoEnrollLoyaltyProgram",false)
json.UpdateBool("profileDetails.privacyInfo.allowPhone",true)
json.UpdateBool("profileDetails.privacyInfo.allowSMS",true)
json.UpdateBool("profileDetails.privacyInfo.allowEmail",true)
json.UpdateBool("profileDetails.privacyInfo.optInMailingList",true)
json.UpdateBool("profileDetails.privacyInfo.optInMarketResearch",true)
json.UpdateBool("profileDetails.privacyInfo.optInThirdParty",true)
json.UpdateBool("profileDetails.privacyInfo.optInAutoEnrollmentMember",true)
json.UpdateBool("profileDetails.privacyInfo.optInPhone",true)
json.UpdateBool("profileDetails.privacyInfo.optInSms",true)
json.UpdateBool("profileDetails.privacyInfo.optInEmail",true)
json.UpdateNewObject("profileDetails.taxInfo")
json.UpdateString("profileDetails.statusCode","Active")
json.UpdateString("profileDetails.requestForHotel","{{HotelId}}")
json.UpdateBool("profileDetails.markAsRecentlyAccessed",true)
json.UpdateString("profileDetails.profileType","Guest")
json.UpdateNewArray("profileIdList")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("x-app-key","{{AppKey}}")
http.SetRequestHeader("x-hotelid","{{HotelId}}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/crm/v1/profiles","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "x-app-key: {{AppKey}}"
-H "x-hotelid: {{HotelId}}"
-d '{
"profileDetails": {
"customer": {
"personName": [
{
"givenName": "James",
"surname": "Smith",
"nameType": "Primary"
},
{
"nameType": "Alternate"
},
{
"nameType": "Incognito"
}
],
"alienInfo": {},
"birthCountry": {
"code": ""
},
"language": "E"
},
"addresses": {
"addressInfo": [
{
"address": {
"isValidated": false,
"addressLine": [
"3450 North Triumph Boulevard",
"Suite 300",
"",
""
],
"cityName": "Lehi",
"postalCode": "84043",
"state": "UT",
"country": {
"value": "US"
},
"language": "E",
"type": "BUSINESS",
"primaryInd": true
}
}
]
},
"telephones": {
"telephoneInfo": [
{
"telephone": {
"phoneTechType": "PHONE",
"phoneUseType": "HOME",
"phoneNumber": "+1 385 555 0102",
"orderSequence": "1",
"primaryInd": true
}
}
]
},
"mailingActions": {
"active": true
},
"privacyInfo": {
"marketResearchParticipation": true,
"infoFromThirdParty": true,
"autoEnrollLoyaltyProgram": false,
"allowPhone": true,
"allowSMS": true,
"allowEmail": true,
"optInMailingList": true,
"optInMarketResearch": true,
"optInThirdParty": true,
"optInAutoEnrollmentMember": true,
"optInPhone": true,
"optInSms": true,
"optInEmail": true
},
"taxInfo": {},
"statusCode": "Active",
"requestForHotel": "{{HotelId}}",
"markAsRecentlyAccessed": true,
"profileType": "Guest"
},
"profileIdList": []
}'
https://domain.com/crm/v1/profiles
Postman Collection Item JSON
{
"name": "Create New Profile If one doesn't exist",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var data = pm.response.headers.get(\"Location\").split(\"/\").pop();\r",
"postman.setEnvironmentVariable(\"ProfileId\", data);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{Token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "x-app-key",
"type": "text",
"value": "{{AppKey}}"
},
{
"key": "x-hotelid",
"type": "text",
"value": "{{HotelId}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"profileDetails\": {\n \"customer\": {\n \"personName\": [\n {\n \"givenName\": \"James\",\n \"surname\": \"Smith\",\n \"nameType\": \"Primary\"\n },\n {\n \"nameType\": \"Alternate\"\n },\n {\n \"nameType\": \"Incognito\"\n }\n ],\n \"alienInfo\": {},\n \"birthCountry\": {\n \"code\": \"\"\n },\n \"language\": \"E\"\n },\n \"addresses\": {\n \"addressInfo\": [\n {\n \"address\": {\n \"isValidated\": false,\n \"addressLine\": [\n \"3450 North Triumph Boulevard\",\n \"Suite 300\",\n \"\",\n \"\"\n ],\n \"cityName\": \"Lehi\",\n \"postalCode\": \"84043\",\n \"state\": \"UT\",\n \"country\": {\n \"value\": \"US\"\n },\n \"language\": \"E\",\n \"type\": \"BUSINESS\",\n \"primaryInd\": true\n }\n }\n ]\n },\n \"telephones\": {\n \"telephoneInfo\": [\n {\n \"telephone\": {\n \"phoneTechType\": \"PHONE\",\n \"phoneUseType\": \"HOME\",\n \"phoneNumber\": \"+1 385 555 0102\",\n \"orderSequence\": \"1\",\n \"primaryInd\": true\n }\n }\n ]\n },\n \"mailingActions\": {\n \"active\": true\n },\n \"privacyInfo\": {\n \"marketResearchParticipation\": true,\n \"infoFromThirdParty\": true,\n \"autoEnrollLoyaltyProgram\": false,\n \"allowPhone\": true,\n \"allowSMS\": true,\n \"allowEmail\": true,\n \"optInMailingList\": true,\n \"optInMarketResearch\": true,\n \"optInThirdParty\": true,\n \"optInAutoEnrollmentMember\": true,\n \"optInPhone\": true,\n \"optInSms\": true,\n \"optInEmail\": true\n },\n \"taxInfo\": {},\n \"statusCode\": \"Active\",\n \"requestForHotel\": \"{{HotelId}}\",\n \"markAsRecentlyAccessed\": true,\n \"profileType\": \"Guest\"\n },\n \"profileIdList\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HostName}}/crm/v1/profiles",
"host": [
"{{HostName}}"
],
"path": [
"crm",
"v1",
"profiles"
]
}
},
"response": [
]
}