Chilkat Online Tools

Node.js / CleverTap API / Create Campaign API - Target User Events & Properties

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

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

    var json = new chilkat.JsonObject();
    json.UpdateString("name","My Sms API campaign");
    json.UpdateBool("estimate_only",true);
    json.UpdateString("target_mode","sms");
    json.UpdateString("where.event_name","Charged");
    json.UpdateInt("where.from",20171001);
    json.UpdateInt("where.to",20171220);
    json.UpdateString("where.common_profile_properties.profile_fields[0].name","Customer Type");
    json.UpdateString("where.common_profile_properties.profile_fields[0].operator","equals");
    json.UpdateString("where.common_profile_properties.profile_fields[0].value","Platinum");
    json.UpdateBool("respect_frequency_caps",false);
    json.UpdateString("content.body","Sms body");
    json.UpdateString("when","now");

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

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.clevertap.com/1/targets/create.json","{{type}}",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

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