Chilkat Online Tools

phpAx / Zoho CRM REST APIs / Campaigns

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('data[0].Campaign_Name','Sample');
$json->UpdateString('data[0].End_Date','2021-01-31');
$json->UpdateInt('data[0].Expected_Revenue',5000);
$json->UpdateString('data[0].Start_Date','2021-01-29');
$json->UpdateBool('data[0].$approved',1);
$json->UpdateString('data[0].Status','Planning');
$json->UpdateString('data[0].Type','Conference');
$json->UpdateInt('data[0].Budgeted_Cost',2500);

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2.1/Campaigns/upsert','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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