Chilkat Online Tools

autoit / CleverTap API / Create Campaign API - Target User Events & Properties

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "name": "My Sms API campaign",
;   "estimate_only": true,
;   "target_mode": "sms",
;   "where": {
;     "event_name": "Charged",
;     "from": 20171001,
;     "to": 20171220,
;     "common_profile_properties": {
;       "profile_fields": [
;         {
;           "name": "Customer Type",
;           "operator": "equals",
;           "value": "Platinum"
;         }
;       ]
;     }
;   },
;   "respect_frequency_caps": false,
;   "content": {
;     "body": "Sms body"
;   },
;   "when": "now"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("name","My Sms API campaign")
$oJson.UpdateBool("estimate_only",True)
$oJson.UpdateString("target_mode","sms")
$oJson.UpdateString("where.event_name","Charged")
$oJson.UpdateInt("where.from",20171001)
$oJson.UpdateInt("where.to",20171220)
$oJson.UpdateString("where.common_profile_properties.profile_fields[0].name","Customer Type")
$oJson.UpdateString("where.common_profile_properties.profile_fields[0].operator","equals")
$oJson.UpdateString("where.common_profile_properties.profile_fields[0].value","Platinum")
$oJson.UpdateBool("respect_frequency_caps",False)
$oJson.UpdateString("content.body","Sms body")
$oJson.UpdateString("when","now")

$oHttp.SetRequestHeader "X-CleverTap-Passcode","{{passcode}}"
$oHttp.SetRequestHeader "X-CleverTap-Account-Id","{{id}}"
$oHttp.SetRequestHeader "Content-Type","{{type}}"

Local $oResp = $oHttp.PostJson3("https://api.clevertap.com/1/targets/create.json","{{type}}",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "X-CleverTap-Account-Id: {{id}}"
	-H "X-CleverTap-Passcode: {{passcode}}"
	-H "Content-Type: {{type}}"
	-d '{"name": "My Sms API campaign","estimate_only": true,"target_mode":"sms", "where":{"event_name":"Charged","from":20171001,"to":20171220,"common_profile_properties":{"profile_fields": [ {"name": "Customer Type","operator":"equals","value": "Platinum"}]}},"respect_frequency_caps": false,"content": { "body": "Sms body"},"when": "now"}'
https://api.clevertap.com/1/targets/create.json

Postman Collection Item JSON

{
  "name": "Create Campaign API - Target User Events & Properties",
  "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": " {\"name\": \"My Sms API campaign\",\"estimate_only\": true,\"target_mode\":\"sms\", \"where\":{\"event_name\":\"Charged\",\"from\":20171001,\"to\":20171220,\"common_profile_properties\":{\"profile_fields\": [ {\"name\": \"Customer Type\",\"operator\":\"equals\",\"value\": \"Platinum\"}]}},\"respect_frequency_caps\": false,\"content\": { \"body\": \"Sms body\"},\"when\": \"now\"}"
    },
    "url": {
      "raw": "https://api.clevertap.com/1/targets/create.json",
      "protocol": "https",
      "host": [
        "api",
        "clevertap",
        "com"
      ],
      "path": [
        "1",
        "targets",
        "create.json"
      ]
    },
    "description": "https://developer.clevertap.com/docs/create-campaign-api#section-create-campaign-api-target-user-events-properties"
  },
  "response": [
  ]
}