Chilkat Online Tools

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

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.

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

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

    CkJsonObject::ckUpdateString(json,"to.FBID[0]","102029292929388")
    CkJsonObject::ckUpdateString(json,"to.FBID[1]","114342342453463")
    CkJsonObject::ckUpdateString(json,"to.GPID[0]","1928288389299292")
    CkJsonObject::ckUpdateString(json,"to.Email[0]","john@doe.com")
    CkJsonObject::ckUpdateString(json,"to.Email[1]","jane@doe.com")
    CkJsonObject::ckUpdateString(json,"to.Identity[0]","JohnDoe")
    CkJsonObject::ckUpdateString(json,"to.objectId[0]","_asdnkansdjknaskdjnasjkndja")
    CkJsonObject::ckUpdateString(json,"to.objectId[1]","-adffajjdfoaiaefiohnefwprjf")
    CkJsonObject::ckUpdateString(json,"tag_group","my tag group")
    CkJsonObject::ckUpdateBool(json,"respect_frequency_caps",0)
    CkJsonObject::ckUpdateString(json,"content.subject","Welcome")
    CkJsonObject::ckUpdateString(json,"content.body","<div>Your HTML content for the email</div>")
    CkJsonObject::ckUpdateString(json,"content.sender_name","CleverTap")

    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/send/email.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 '{
    "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": [
  ]
}