Chilkat Online Tools

TCL / CleverTap API / Create Campaign API - Target Users by their Identities(WEB PUSH)

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.

# {
#   "to": {
#     "FBID": [
#       "102029292929388",
#       "114342342453463"
#     ],
#     "GPID": [
#       "1928288389299292"
#     ],
#     "Email": [
#       "john@doe.com",
#       "jane@doe.com"
#     ],
#     "Identity": [
#       "JohnDoe"
#     ],
#     "objectId": [
#       "_asdnkansdjknaskdjnasjkndja",
#       "-adffajjdfoaiaefiohnefwprjf"
#     ]
#   },
#   "tag_group": "my tag group",
#   "respect_frequency_caps": false,
#   "content": {
#     "title": "Hi!",
#     "body": "How are you doing today?",
#     "platform_specific": {
#       "chrome": {
#         "image": "https://www.exampleImage.com",
#         "icon": "https://www.exampleIcon.com",
#         "deep_link": "http://www.example.com",
#         "ttl": 10,
#         "require_interaction": true,
#         "cta_title1": "title",
#         "cta_link1": "http://www.example2.com",
#         "cta_iconlink1": "https://www.exampleIcon2.com"
#       }
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "to.FBID[0]" "102029292929388"
CkJsonObject_UpdateString $json "to.FBID[1]" "114342342453463"
CkJsonObject_UpdateString $json "to.GPID[0]" "1928288389299292"
CkJsonObject_UpdateString $json "to.Email[0]" "john@doe.com"
CkJsonObject_UpdateString $json "to.Email[1]" "jane@doe.com"
CkJsonObject_UpdateString $json "to.Identity[0]" "JohnDoe"
CkJsonObject_UpdateString $json "to.objectId[0]" "_asdnkansdjknaskdjnasjkndja"
CkJsonObject_UpdateString $json "to.objectId[1]" "-adffajjdfoaiaefiohnefwprjf"
CkJsonObject_UpdateString $json "tag_group" "my tag group"
CkJsonObject_UpdateBool $json "respect_frequency_caps" 0
CkJsonObject_UpdateString $json "content.title" "Hi!"
CkJsonObject_UpdateString $json "content.body" "How are you doing today?"
CkJsonObject_UpdateString $json "content.platform_specific.chrome.image" "https://www.exampleImage.com"
CkJsonObject_UpdateString $json "content.platform_specific.chrome.icon" "https://www.exampleIcon.com"
CkJsonObject_UpdateString $json "content.platform_specific.chrome.deep_link" "http://www.example.com"
CkJsonObject_UpdateInt $json "content.platform_specific.chrome.ttl" 10
CkJsonObject_UpdateBool $json "content.platform_specific.chrome.require_interaction" 1
CkJsonObject_UpdateString $json "content.platform_specific.chrome.cta_title1" "title"
CkJsonObject_UpdateString $json "content.platform_specific.chrome.cta_link1" "http://www.example2.com"
CkJsonObject_UpdateString $json "content.platform_specific.chrome.cta_iconlink1" "https://www.exampleIcon2.com"

CkHttp_SetRequestHeader $http "X-CleverTap-Passcode" "{{passcode}}"
CkHttp_SetRequestHeader $http "X-CleverTap-Account-Id" "{{id}}"
CkHttp_SetRequestHeader $http "Content-Type" "{{type}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.clevertap.com/1/send/webpush.json" "{{type}}" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "X-CleverTap-Account-Id: {{id}}"
	-H "X-CleverTap-Passcode: {{passcode}}"
	-H "Content-Type: {{type}}"
	-d '{
    "to": {
        "FBID": [
            "102029292929388",
            "114342342453463"
        ],
        "GPID": [
            "1928288389299292"
        ],
        "Email": [
            "john@doe.com",
            "jane@doe.com"
        ],
        "Identity": [
            "JohnDoe"
        ],
        "objectId": [
            "_asdnkansdjknaskdjnasjkndja",
            "-adffajjdfoaiaefiohnefwprjf"
        ]
    },
    "tag_group": "my tag group",
    "respect_frequency_caps": false,
     "content": {
        "title": "Hi!",
        "body": "How are you doing today?",
        "platform_specific": {
            "chrome": {
                "image": "https://www.exampleImage.com",
              "icon":"https://www.exampleIcon.com",
                "deep_link": "http://www.example.com",
              "ttl":10,
              "require_interaction":true,
              "cta_title1":"title",
              "cta_link1":"http://www.example2.com",
              "cta_iconlink1":"https://www.exampleIcon2.com"
            }
        }
    }
}'
https://api.clevertap.com/1/send/webpush.json

Postman Collection Item JSON

{
  "name": "Create Campaign API - Target Users by their Identities(WEB PUSH)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-CleverTap-Account-Id",
        "value": "{{id}}"
      },
      {
        "key": "X-CleverTap-Passcode",
        "value": "{{passcode}}"
      },
      {
        "key": "Content-Type",
        "value": "{{type}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"to\": {\n        \"FBID\": [\n            \"102029292929388\",\n            \"114342342453463\"\n        ],\n        \"GPID\": [\n            \"1928288389299292\"\n        ],\n        \"Email\": [\n            \"john@doe.com\",\n            \"jane@doe.com\"\n        ],\n        \"Identity\": [\n            \"JohnDoe\"\n        ],\n        \"objectId\": [\n            \"_asdnkansdjknaskdjnasjkndja\",\n            \"-adffajjdfoaiaefiohnefwprjf\"\n        ]\n    },\n    \"tag_group\": \"my tag group\",\n    \"respect_frequency_caps\": false,\n     \"content\": {\n        \"title\": \"Hi!\",\n        \"body\": \"How are you doing today?\",\n        \"platform_specific\": {\n            \"chrome\": {\n                \"image\": \"https://www.exampleImage.com\",\n              \"icon\":\"https://www.exampleIcon.com\",\n                \"deep_link\": \"http://www.example.com\",\n              \"ttl\":10,\n              \"require_interaction\":true,\n              \"cta_title1\":\"title\",\n              \"cta_link1\":\"http://www.example2.com\",\n              \"cta_iconlink1\":\"https://www.exampleIcon2.com\"\n            }\n        }\n    }\n}"
    },
    "url": {
      "raw": "https://api.clevertap.com/1/send/webpush.json",
      "protocol": "https",
      "host": [
        "api",
        "clevertap",
        "com"
      ],
      "path": [
        "1",
        "send",
        "webpush.json"
      ]
    }
  },
  "response": [
  ]
}