Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

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

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

    var resp: CkoHttpResponse? = http.PostJson3("https://api.clevertap.com/1/targets/create.json", contentType: "{{type}}", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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