How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Salesforce Channel API

The Channel API from Salesforce — 5 operation(s) for channel.

Salesforce Channel API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Channel. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 9 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version v63.0.

Requests are made against a single base URL, https://{instance}.salesforce.com/services/data/v{version}/jobs.

9 operations 5 paths 19 schemas 2 DELETE3 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v63.0
Base URL
https://{instance}.salesforce.com/services/data
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Salesforce Channel API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {accesstoken}".

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Channel 9
POST
/data/v64.0/tooling/sobjects/PlatformEventChannel
Salesforce Create Channel
Createchannel body → 200
PATCH
/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}
Salesforce Update Channel
Updatechannel 1 param body → 200
GET
/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}
Salesforce Get Event Channel
Geteventchannel 1 param → 200
DELETE
/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}
Salesforce Delete Event Channel
Deleteeventchannel 1 param → 204
PATCH
/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}
Salesforce Add Enriched Fields to Channel Member
Addenrichedfieldstochannelmember 1 param body → 200
GET
/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}
Salesforce Get Channel Member
Getchannelmember 1 param → 200
DELETE
/data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}
Salesforce Delete Channel Member
Deletechannelmember 1 param → 200
POST
/data/v64.0/tooling/sobjects/PlatformEventChannelMember
Salesforce Create Channel Member
Createchannelmember body → 200
GET
/data/v64.0/tooling/sobjects/PlatformEventChannel/describe
Salesforce Describe Event Channel
Describeeventchannel → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Field1 (57 properties), Describeeventchannel (45 properties), Getchannelmember (18 properties), Geteventchannel (16 properties). Each schema is shown below with its type and property counts.

UpdatechannelRequest
object
2 properties 2 required
Urls2
object
3 properties 3 required
SupportedScope
object
2 properties 2 required
Metadata1
object
3 properties 3 required
CreatechannelRequest
object
2 properties 2 required
Field1
object
57 properties 57 required
EnrichedField
object
1 property 1 required
CreatechannelmemberRequest
object
2 properties 2 required
PicklistValue
object
5 properties
Describeeventchannel
object
45 properties 45 required
Metadata3
object
2 properties 2 required
Metadata2
object
3 properties 3 required
AddenrichedfieldstochannelmemberRequest
object
2 properties 2 required
Metadata9
object
5 properties 5 required
PicklistValue1
object
5 properties 5 required
Getchannelmember
object
18 properties 18 required
Geteventchannel
object
16 properties 16 required
Metadata
object
2 properties 2 required
Attributes4
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-channel-api-openapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Channel API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.