Chilkat Online Tools

phpAx / Salesforce Platform APIs / Add enriched fields to channel member

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.

// {
//   "FullName": "Account_Channel_chn_AccountChangeEvent",
//   "Metadata": {
//     "enrichedFields": [
//       {
//         "name": "External_Account_ID__c"
//       }
//     ],
//     "eventChannel": "Account_Channel__chn",
//     "selectedEntity": "AccountChangeEvent"
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('FullName','Account_Channel_chn_AccountChangeEvent');
$json->UpdateString('Metadata.enrichedFields[0].name','External_Account_ID__c');
$json->UpdateString('Metadata.eventChannel','Account_Channel__chn');
$json->UpdateString('Metadata.selectedEntity','AccountChangeEvent');

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

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


?>

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "FullName": "Account_Channel_chn_AccountChangeEvent",
    "Metadata": {
        "enrichedFields": [
            {
                "name": "External_Account_ID__c"
            }
        ],
        "eventChannel": "Account_Channel__chn",
        "selectedEntity": "AccountChangeEvent"
    }
}'
https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID

Postman Collection Item JSON

{
  "name": "Add enriched fields to channel member",
  "protocolProfileBehavior": {
    "strictSSL": false
  },
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"FullName\": \"Account_Channel_chn_AccountChangeEvent\",\n    \"Metadata\": {\n        \"enrichedFields\": [\n            {\n                \"name\": \"External_Account_ID__c\"\n            }\n        ],\n        \"eventChannel\": \"Account_Channel__chn\",\n        \"selectedEntity\": \"AccountChangeEvent\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "sobjects",
        "PlatformEventChannelMember",
        ":PLATFORM_EVENT_CHANNEL_MEMBER_ID"
      ],
      "variable": [
        {
          "key": "PLATFORM_EVENT_CHANNEL_MEMBER_ID",
          "value": ""
        }
      ]
    }
  },
  "response": [
  ]
}