Chilkat Online Tools

phpExt / Salesforce Platform APIs / Update channel

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "FullName": "Carbon_Comparison_Channel__chn",
//   "Metadata": {
//     "channelType": "event",
//     "label": "Carbon Comparison Channel 2",
//     "urls": null
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('FullName','Carbon_Comparison_Channel__chn');
$json->UpdateString('Metadata.channelType','event');
$json->UpdateString('Metadata.label','Carbon Comparison Channel 2');
$json->UpdateNull('Metadata.urls');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "FullName": "Carbon_Comparison_Channel__chn",
    "Metadata": {
        "channelType": "event",
        "label": "Carbon Comparison Channel 2",
        "urls": null
    }
}'
https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID

Postman Collection Item JSON

{
  "name": "Update channel",
  "protocolProfileBehavior": {
    "strictSSL": false
  },
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"FullName\": \"Carbon_Comparison_Channel__chn\",\n    \"Metadata\": {\n        \"channelType\": \"event\",\n        \"label\": \"Carbon Comparison Channel 2\",\n        \"urls\": null\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "sobjects",
        "PlatformEventChannel",
        ":PLATFORM_EVENT_CHANNEL_ID"
      ],
      "variable": [
        {
          "key": "PLATFORM_EVENT_CHANNEL_ID",
          "value": ""
        }
      ]
    }
  },
  "response": [
  ]
}