Chilkat Online Tools

TCL / Salesforce Platform APIs / Individual Member Enrollments

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "enrollmentDate": "2021-01-01T00:00:00",
#   "membershipNumber": "Member1",
#   "associatedContactDetails": {
#     "firstName": "Name1",
#     "lastName": "Name2",
#     "email": "ab@email.com",
#     "allowDuplicateRecords": "false"
#   },
#   "memberStatus": "Active",
#   "createTransactionJournals": "true",
#   "transactionJournalStatementFrequency": "Monthly",
#   "transactionJournalStatementMethod": "Mail",
#   "enrollmentChannel": "Email",
#   "canReceivePromotions": "true",
#   "canReceivePartnerPromotions": "true",
#   "membershipEndDate": "2022-01-01T00:00:00"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "enrollmentDate" "2021-01-01T00:00:00"
CkJsonObject_UpdateString $json "membershipNumber" "Member1"
CkJsonObject_UpdateString $json "associatedContactDetails.firstName" "Name1"
CkJsonObject_UpdateString $json "associatedContactDetails.lastName" "Name2"
CkJsonObject_UpdateString $json "associatedContactDetails.email" "ab@email.com"
CkJsonObject_UpdateString $json "associatedContactDetails.allowDuplicateRecords" "false"
CkJsonObject_UpdateString $json "memberStatus" "Active"
CkJsonObject_UpdateString $json "createTransactionJournals" "true"
CkJsonObject_UpdateString $json "transactionJournalStatementFrequency" "Monthly"
CkJsonObject_UpdateString $json "transactionJournalStatementMethod" "Mail"
CkJsonObject_UpdateString $json "enrollmentChannel" "Email"
CkJsonObject_UpdateString $json "canReceivePromotions" "true"
CkJsonObject_UpdateString $json "canReceivePartnerPromotions" "true"
CkJsonObject_UpdateString $json "membershipEndDate" "2022-01-01T00:00:00"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "contactId": "003J8000002Yu0Z",
#   "loyaltyProgramMemberId": "0lMJ8000000CaRM",
#   "loyaltyProgramName": "NTO Insider",
#   "membershipNumber": "Member1",
#   "transactionJournals": [
#     {
#       "activityDate": "2020-12-31T23:00:00.000Z",
#       "journalSubType": "Member Enrollment",
#       "journalType": "Accrual",
#       "loyaltyProgram": "NTO Insider",
#       "loyaltyProgramMember": "Member1",
#       "referredMember": null,
#       "status": "Processed",
#       "transactionJournalId": "0lVJ8000000GmaJ"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set contactId [CkJsonObject_stringOf $jResp "contactId"]
set loyaltyProgramMemberId [CkJsonObject_stringOf $jResp "loyaltyProgramMemberId"]
set loyaltyProgramName [CkJsonObject_stringOf $jResp "loyaltyProgramName"]
set membershipNumber [CkJsonObject_stringOf $jResp "membershipNumber"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "transactionJournals"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set activityDate [CkJsonObject_stringOf $jResp "transactionJournals[i].activityDate"]
    set journalSubType [CkJsonObject_stringOf $jResp "transactionJournals[i].journalSubType"]
    set journalType [CkJsonObject_stringOf $jResp "transactionJournals[i].journalType"]
    set loyaltyProgram [CkJsonObject_stringOf $jResp "transactionJournals[i].loyaltyProgram"]
    set loyaltyProgramMember [CkJsonObject_stringOf $jResp "transactionJournals[i].loyaltyProgramMember"]
    set referredMember [CkJsonObject_stringOf $jResp "transactionJournals[i].referredMember"]
    set status [CkJsonObject_stringOf $jResp "transactionJournals[i].status"]
    set transactionJournalId [CkJsonObject_stringOf $jResp "transactionJournals[i].transactionJournalId"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "enrollmentDate" : "2021-01-01T00:00:00",
  "membershipNumber" : "Member1",
  "associatedContactDetails" : {
    "firstName" : "Name1",
    "lastName" : "Name2",
    "email" : "ab@email.com",
    "allowDuplicateRecords" : "false"
  },

  "memberStatus" : "Active",
  "createTransactionJournals" : "true",
  "transactionJournalStatementFrequency" : "Monthly",
  "transactionJournalStatementMethod" : "Mail",
  "enrollmentChannel" : "Email",
  "canReceivePromotions": "true",
  "canReceivePartnerPromotions" : "true",
  "membershipEndDate" : "2022-01-01T00:00:00"
}'
https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments

Postman Collection Item JSON

{
  "name": "Individual Member Enrollments",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"enrollmentDate\" : \"2021-01-01T00:00:00\",\n  \"membershipNumber\" : \"Member1\",\n  \"associatedContactDetails\" : {\n    \"firstName\" : \"Name1\",\n    \"lastName\" : \"Name2\",\n    \"email\" : \"ab@email.com\",\n    \"allowDuplicateRecords\" : \"false\"\n  },\n\n  \"memberStatus\" : \"Active\",\n  \"createTransactionJournals\" : \"true\",\n  \"transactionJournalStatementFrequency\" : \"Monthly\",\n  \"transactionJournalStatementMethod\" : \"Mail\",\n  \"enrollmentChannel\" : \"Email\",\n  \"canReceivePromotions\": \"true\",\n  \"canReceivePartnerPromotions\" : \"true\",\n  \"membershipEndDate\" : \"2022-01-01T00:00:00\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "loyalty-programs",
        ":loyaltyProgramName",
        "individual-member-enrollments"
      ],
      "query": [
        {
          "key": "",
          "value": "",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm)"
  },
  "response": [
    {
      "name": "Individual Member Enrollments",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"enrollmentDate\" : \"2021-01-01T00:00:00\",\n  \"membershipNumber\" : \"Member1\",\n  \"associatedContactDetails\" : {\n    \"firstName\" : \"Name1\",\n    \"lastName\" : \"Name2\",\n    \"email\" : \"ab@email.com\",\n    \"allowDuplicateRecords\" : \"false\"\n  },\n\n  \"memberStatus\" : \"Active\",\n  \"createTransactionJournals\" : \"true\",\n  \"transactionJournalStatementFrequency\" : \"Monthly\",\n  \"transactionJournalStatementMethod\" : \"Mail\",\n  \"enrollmentChannel\" : \"Email\",\n  \"canReceivePromotions\": \"true\",\n  \"canReceivePartnerPromotions\" : \"true\",\n  \"membershipEndDate\" : \"2022-01-01T00:00:00\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "loyalty-programs",
            ":loyaltyProgramName",
            "individual-member-enrollments"
          ],
          "query": [
            {
              "key": "",
              "value": null,
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 May 2024 15:39:01 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"contactId\": \"003J8000002Yu0Z\",\n    \"loyaltyProgramMemberId\": \"0lMJ8000000CaRM\",\n    \"loyaltyProgramName\": \"NTO Insider\",\n    \"membershipNumber\": \"Member1\",\n    \"transactionJournals\": [\n        {\n            \"activityDate\": \"2020-12-31T23:00:00.000Z\",\n            \"journalSubType\": \"Member Enrollment\",\n            \"journalType\": \"Accrual\",\n            \"loyaltyProgram\": \"NTO Insider\",\n            \"loyaltyProgramMember\": \"Member1\",\n            \"referredMember\": null,\n            \"status\": \"Processed\",\n            \"transactionJournalId\": \"0lVJ8000000GmaJ\"\n        }\n    ]\n}"
    }
  ]
}