Chilkat Online Tools

phpAx / CleverTap API / Create Campaign API - Target Users by their Identities(EMAIL)

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// 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": {
//     "subject": "Welcome",
//     "body": "<div>Your HTML content for the email</div>",
//     "sender_name": "CleverTap"
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('to.FBID[0]','102029292929388');
$json->UpdateString('to.FBID[1]','114342342453463');
$json->UpdateString('to.GPID[0]','1928288389299292');
$json->UpdateString('to.Email[0]','john@doe.com');
$json->UpdateString('to.Email[1]','jane@doe.com');
$json->UpdateString('to.Identity[0]','JohnDoe');
$json->UpdateString('to.objectId[0]','_asdnkansdjknaskdjnasjkndja');
$json->UpdateString('to.objectId[1]','-adffajjdfoaiaefiohnefwprjf');
$json->UpdateString('tag_group','my tag group');
$json->UpdateBool('respect_frequency_caps',0);
$json->UpdateString('content.subject','Welcome');
$json->UpdateString('content.body','<div>Your HTML content for the email</div>');
$json->UpdateString('content.sender_name','CleverTap');

$http->SetRequestHeader('X-CleverTap-Passcode','{{passcode}}');
$http->SetRequestHeader('X-CleverTap-Account-Id','{{id}}');
$http->SetRequestHeader('Content-Type','{{type}}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.clevertap.com/1/send/email.json','{{type}}',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->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 '{
    "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": {
        "subject": "Welcome",
        "body": "<div>Your HTML content for the email</div>",
        "sender_name": "CleverTap"
    }
}'
https://api.clevertap.com/1/send/email.json

Postman Collection Item JSON

{
  "name": "Create Campaign API - Target Users by their Identities(EMAIL)",
  "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        \"subject\": \"Welcome\",\n        \"body\": \"<div>Your HTML content for the email</div>\",\n        \"sender_name\": \"CleverTap\"\n    }\n}"
    },
    "url": {
      "raw": "https://api.clevertap.com/1/send/email.json",
      "protocol": "https",
      "host": [
        "api",
        "clevertap",
        "com"
      ],
      "path": [
        "1",
        "send",
        "email.json"
      ]
    }
  },
  "response": [
  ]
}