Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$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.

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

$json = new CkJsonObject();
$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 is a CkHttpResponse
$resp = $http->PostJson3('https://api.clevertap.com/1/targets/create.json','{{type}}',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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