Chilkat Online Tools

SQL Server / CleverTap API / Create Campaign API - Target User Events & Properties

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'My Sms API campaign'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'estimate_only', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'target_mode', 'sms'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'where.event_name', 'Charged'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'where.from', 20171001
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'where.to', 20171220
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'where.common_profile_properties.profile_fields[0].name', 'Customer Type'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'where.common_profile_properties.profile_fields[0].operator', 'equals'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'where.common_profile_properties.profile_fields[0].value', 'Platinum'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'respect_frequency_caps', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.body', 'Sms body'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'when', 'now'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-CleverTap-Passcode', '{{passcode}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-CleverTap-Account-Id', '{{id}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', '{{type}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.clevertap.com/1/targets/create.json', '{{type}}', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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