Salesforce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salesforce Channel API

9 actions 9 updates phrasing extends openapi/salesforce-channel-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Salesforce's API. It is a proposal applied on top of the contract, not a document Salesforce publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel'].post
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].get
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].delete
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].patch
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}'].get
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}'].delete
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember'].post
$.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/describe'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Channel API
  version: 1.0.0
extends: openapi/salesforce-channel-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a platform event channel
      effect: write
      questions:
      - How do I create a custom channel to group platform events or change events?
      - Can I set up a new PlatformEventChannel through the Tooling API?
      instructions:
      - text: Create platform event channel {full_name} with metadata {metadata}.
        slots:
          full_name: requestBody.FullName
          metadata: requestBody.Metadata
      - text: Set up a new custom event channel called {full_name}.
        slots:
          full_name: requestBody.FullName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform event channel
      effect: read
      questions:
      - How do I look up one platform event channel's definition?
      - What channel type and label does my custom event channel have?
      instructions:
      - text: Get platform event channel {channel_id}.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
      - text: Show the definition of event channel {channel_id}.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a platform event channel
      effect: destructive
      questions:
      - How do I remove a custom platform event channel I no longer need?
      - Can I delete an event channel through the Tooling API?
      instructions:
      - text: Delete platform event channel {channel_id}.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
      - text: Remove the custom event channel {channel_id} from the org.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a platform event channel
      effect: write
      questions:
      - How do I rename or change the metadata of an existing event channel?
      - Can I modify a PlatformEventChannel after it's created?
      instructions:
      - text: Update event channel {channel_id} with metadata {metadata}.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
          metadata: requestBody.Metadata
      - text: Change channel {channel_id} full name to {full_name}.
        slots:
          channel_id: path.PLATFORM_EVENT_CHANNEL_ID
          full_name: requestBody.FullName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform event channel member
      effect: read
      questions:
      - Which event is a given channel member mapped to?
      - How do I inspect one member of a platform event channel, including its filter?
      instructions:
      - text: Get channel member {member_id}.
        slots:
          member_id: path.PLATFORM_EVENT_CHANNEL_MEMBER_ID
      - text: Show which event and filter channel member {member_id} uses.
        slots:
          member_id: path.PLATFORM_EVENT_CHANNEL_MEMBER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an event from a channel
      effect: destructive
      questions:
      - How do I take an event out of a custom channel?
      - Can I delete a channel member without deleting the whole channel?
      instructions:
      - text: Delete channel member {member_id}.
        slots:
          member_id: path.PLATFORM_EVENT_CHANNEL_MEMBER_ID
      - text: Remove member {member_id} from its platform event channel.
        slots:
          member_id: path.PLATFORM_EVENT_CHANNEL_MEMBER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannelMember'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an event to a platform event channel
      effect: write
      questions:
      - How do I add a platform event or change event to a custom channel?
      - Can I add a channel member with a filter expression?
      instructions:
      - text: Add channel member {full_name} with metadata {metadata}.
        slots:
          full_name: requestBody.FullName
          metadata: requestBody.Metadata
      - text: Create a PlatformEventChannelMember named {full_name}.
        slots:
          full_name: requestBody.FullName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/PlatformEventChannel/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the platform event channel object
      effect: read
      questions:
      - Which fields does the PlatformEventChannel object have?
      - What does the describe of the event channel Tooling object return?
      instructions:
      - text: Describe the PlatformEventChannel object.
      - text: Show field metadata for platform event channels.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/salesforce-channel-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.