Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"profileDetails.customer.personName[0].givenName","James")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.personName[0].surname","Smith")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.personName[0].nameType","Primary")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.personName[1].nameType","Alternate")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.personName[2].nameType","Incognito")
CkJsonObject::ckUpdateNewObject(json,"profileDetails.customer.alienInfo")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.birthCountry.code","")
CkJsonObject::ckUpdateString(json,"profileDetails.customer.language","E")
CkJsonObject::ckUpdateBool(json,"profileDetails.addresses.addressInfo[0].address.isValidated",0)
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.addressLine[0]","3450 North Triumph Boulevard")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.addressLine[1]","Suite 300")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.addressLine[2]","")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.addressLine[3]","")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.cityName","Lehi")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.postalCode","84043")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.state","UT")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.country.value","US")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.language","E")
CkJsonObject::ckUpdateString(json,"profileDetails.addresses.addressInfo[0].address.type","BUSINESS")
CkJsonObject::ckUpdateBool(json,"profileDetails.addresses.addressInfo[0].address.primaryInd",1)
CkJsonObject::ckUpdateString(json,"profileDetails.telephones.telephoneInfo[0].telephone.phoneTechType","PHONE")
CkJsonObject::ckUpdateString(json,"profileDetails.telephones.telephoneInfo[0].telephone.phoneUseType","HOME")
CkJsonObject::ckUpdateString(json,"profileDetails.telephones.telephoneInfo[0].telephone.phoneNumber","+1 385 555 0102")
CkJsonObject::ckUpdateString(json,"profileDetails.telephones.telephoneInfo[0].telephone.orderSequence","1")
CkJsonObject::ckUpdateBool(json,"profileDetails.telephones.telephoneInfo[0].telephone.primaryInd",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.mailingActions.active",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.marketResearchParticipation",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.infoFromThirdParty",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.autoEnrollLoyaltyProgram",0)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.allowPhone",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.allowSMS",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.allowEmail",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInMailingList",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInMarketResearch",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInThirdParty",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInAutoEnrollmentMember",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInPhone",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInSms",1)
CkJsonObject::ckUpdateBool(json,"profileDetails.privacyInfo.optInEmail",1)
CkJsonObject::ckUpdateNewObject(json,"profileDetails.taxInfo")
CkJsonObject::ckUpdateString(json,"profileDetails.statusCode","Active")
CkJsonObject::ckUpdateString(json,"profileDetails.requestForHotel","{{HotelId}}")
CkJsonObject::ckUpdateBool(json,"profileDetails.markAsRecentlyAccessed",1)
CkJsonObject::ckUpdateString(json,"profileDetails.profileType","Guest")
CkJsonObject::ckUpdateNewArray(json,"profileIdList")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")
CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v1/profiles","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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": [
]
}
