Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"name","My Sms API campaign")
    CkJsonObject::ckUpdateBool(json,"estimate_only",1)
    CkJsonObject::ckUpdateString(json,"target_mode","sms")
    CkJsonObject::ckUpdateString(json,"where.event_name","Charged")
    CkJsonObject::ckUpdateInt(json,"where.from",20171001)
    CkJsonObject::ckUpdateInt(json,"where.to",20171220)
    CkJsonObject::ckUpdateString(json,"where.common_profile_properties.profile_fields[0].name","Customer Type")
    CkJsonObject::ckUpdateString(json,"where.common_profile_properties.profile_fields[0].operator","equals")
    CkJsonObject::ckUpdateString(json,"where.common_profile_properties.profile_fields[0].value","Platinum")
    CkJsonObject::ckUpdateBool(json,"respect_frequency_caps",0)
    CkJsonObject::ckUpdateString(json,"content.body","Sms body")
    CkJsonObject::ckUpdateString(json,"when","now")

    CkHttp::ckSetRequestHeader(http,"X-CleverTap-Passcode","{{passcode}}")
    CkHttp::ckSetRequestHeader(http,"X-CleverTap-Account-Id","{{id}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","{{type}}")

    resp.i = CkHttp::ckPostJson3(http,"https://api.clevertap.com/1/targets/create.json","{{type}}",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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