Chilkat Online Tools

Ruby / Salesforce Platform APIs / Update channel

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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",
#   "Metadata": {
#     "channelType": "data",
#     "label": "Account Channel 2",
#     "urls": null
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("FullName","Account_Channel__chn")
json.UpdateString("Metadata.channelType","data")
json.UpdateString("Metadata.label","Account Channel 2")
json.UpdateNull("Metadata.urls")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
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
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "FullName": "Account_Channel__chn",
    "Metadata": {
        "channelType": "data",
        "label": "Account 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\": \"Account_Channel__chn\",\n    \"Metadata\": {\n        \"channelType\": \"data\",\n        \"label\": \"Account 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": "0YLRM0000004DlP4AU"
        }
      ]
    }
  },
  "response": [
  ]
}