Chilkat Online Tools

SQL Server / Zoho CRM REST APIs / Campaigns

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.

    -- {
    --   "data": [
    --     {
    --       "Campaign_Name": "Sample",
    --       "End_Date": "2021-01-31",
    --       "Expected_Revenue": 5000,
    --       "Start_Date": "2021-01-29",
    --       "$approved": true,
    --       "Status": "Planning",
    --       "Type": "Conference",
    --       "Budgeted_Cost": 2500
    --     }
    --   ]
    -- }

    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, 'data[0].Campaign_Name', 'Sample'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].End_Date', '2021-01-31'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'data[0].Expected_Revenue', 5000
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Start_Date', '2021-01-29'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'data[0].$approved', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Status', 'Planning'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Type', 'Conference'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'data[0].Budgeted_Cost', 2500

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/crm/v2.1/Campaigns/upsert', 'application/json', @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 "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Campaign_Name": "Sample",
            "End_Date": "2021-01-31",
            "Expected_Revenue": 5000,
            "Start_Date": "2021-01-29",
            "$approved": true,
            "Status": "Planning",
            "Type": "Conference",
            "Budgeted_Cost": 2500
        }
    ]
}'
https://domain.com/crm/v2.1/Campaigns/upsert

Postman Collection Item JSON

{
  "name": "Campaigns",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Campaign_Name\": \"Sample\",\n            \"End_Date\": \"2021-01-31\",\n            \"Expected_Revenue\": 5000,\n            \"Start_Date\": \"2021-01-29\",\n            \"$approved\": true,\n            \"Status\": \"Planning\",\n            \"Type\": \"Conference\",\n            \"Budgeted_Cost\": 2500\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Campaigns/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Campaigns",
        "upsert"
      ]
    },
    "description": "To upsert records in the Campaigns module."
  },
  "response": [
  ]
}