Chilkat Online Tools

lianja / 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.

loHttp = createobject("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.

// {
//   "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"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("name","My Sms API campaign")
loJson.UpdateBool("estimate_only",.T.)
loJson.UpdateString("target_mode","sms")
loJson.UpdateString("where.event_name","Charged")
loJson.UpdateInt("where.from",20171001)
loJson.UpdateInt("where.to",20171220)
loJson.UpdateString("where.common_profile_properties.profile_fields[0].name","Customer Type")
loJson.UpdateString("where.common_profile_properties.profile_fields[0].operator","equals")
loJson.UpdateString("where.common_profile_properties.profile_fields[0].value","Platinum")
loJson.UpdateBool("respect_frequency_caps",.F.)
loJson.UpdateString("content.body","Sms body")
loJson.UpdateString("when","now")

loHttp.SetRequestHeader("X-CleverTap-Passcode","{{passcode}}")
loHttp.SetRequestHeader("X-CleverTap-Account-Id","{{id}}")
loHttp.SetRequestHeader("Content-Type","{{type}}")

loResp = loHttp.PostJson3("https://api.clevertap.com/1/targets/create.json","{{type}}",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

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": [
  ]
}