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

HubSpot Conversations Custom Channels API

HubSpot Conversations Custom Channels — 13 operation(s) from HubSpot's published OpenAPI.

HubSpot Conversations Custom Channels API is one of 144 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 692 JSON Schema definitions.

Tagged areas include Conversations, Custom, and Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 692 JSON Schemas.

This API exposes 13 operations across 7 paths, organized into 4 resource areas, and defines 51 schemas. It is described by OpenAPI 3.0.1, at version 2026-09.

Requests are made against a single base URL, https://api.hubapi.com.

13 operations 7 paths 51 schemas 1 DELETE5 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2026-09
Base URL
https://api.hubapi.com
Authentication
API Key, OAuth 2.0, API Key, API Key
Resource Areas
4

Authentication & Security 4

HubSpot Conversations Custom Channels API declares 4 security schemes for authenticating requests. An API key is passed in the query as hapikey (developer_hapikey). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. An API key is passed in the header as private-app (private_apps). An API key is passed in the header as private-app-legacy (private_apps_legacy).

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 4 PATCH, 3 POST. They span 4 resource areas: Basic, Channels, Channel accounts, Messages. Each is listed below with its method, path, parameters, and response codes.

Basic 2
GET
/conversations/custom-channels/2026-09
get-/conversations/custom-channels/2026-09_/conversations/custom-channels/v3 4 params → 200default
POST
/conversations/custom-channels/2026-09
post-/conversations/custom-channels/2026-09_/conversations/custom-channels/v3 body → 201default
Channels 4
GET
/conversations/custom-channels/2026-09/{channelId}
Get a custom channel
get-/conversations/custom-channels/2026-09/{channelId} 1 param → 200default
DELETE
/conversations/custom-channels/2026-09/{channelId}
Archive a custom channel
delete-/conversations/custom-channels/2026-09/{channelId} 1 param → 204default
PATCH
/conversations/custom-channels/2026-09/{channelId}
Update a custom channel
patch-/conversations/custom-channels/2026-09/{channelId} 1 param body → 200default
GET
/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}
Get a channel account by id
get-/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId} 3 params → 200default
Channel accounts 4
PATCH
/conversations/custom-channels/2026-09/{channelId}/channel-account-staging-tokens/{accountToken}
Update a channel account staging token
patch-/conversations/custom-channels/2026-09/{channelId}/channel-account-staging-tokens/{accountToken} 2 params body → 200default
GET
/conversations/custom-channels/2026-09/{channelId}/channel-accounts
Get accounts for a channel
get-/conversations/custom-channels/2026-09/{channelId}/channel-accounts 8 params → 200default
POST
/conversations/custom-channels/2026-09/{channelId}/channel-accounts
Create a channel account
post-/conversations/custom-channels/2026-09/{channelId}/channel-accounts 1 param body → 201default
PATCH
/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}
Update a channel account
patch-/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId} 2 params body → 200default
Messages 3
POST
/conversations/custom-channels/2026-09/{channelId}/messages
Publish a message
post-/conversations/custom-channels/2026-09/{channelId}/messages 1 param body → 201default
GET
/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
Get a message
get-/conversations/custom-channels/2026-09/{channelId}/messages/{messageId} 2 params → 200default
PATCH
/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
Update a message
patch-/conversations/custom-channels/2026-09/{channelId}/messages/{messageId} 2 params body → 200default

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are PublicConversationsMessage (20 properties), ChannelIntegrationMessageEgg (13 properties), PublicChannelAccount (10 properties), PublicChannelIntegrationChannel (8 properties). Each schema is shown below with its type and property counts.

ChannelIntegrationMessageEgg
object
13 properties 7 required
ChannelIntegrationParticipant
object
3 properties 1 required
CollectionResponseWithTotalPublicChannelAccount
object
3 properties 2 required
CollectionResponseWithTotalPublicChannelIntegrationChannel
object
3 properties 2 required
ContactAddress
object
7 properties
ContactAttachment
object
2 properties 2 required
ContactEmail
object
2 properties 1 required
ContactName
object
5 properties
ContactOrg
object
3 properties
ContactPhone
object
2 properties 1 required
ContactProfile
object
6 properties 4 required
ContactUrl
object
2 properties 1 required
Error
object
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the…
7 properties 3 required
ErrorDetail
object
Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typic…
5 properties 1 required
FileAttachment
object
3 properties 2 required
LocationAttachment
object
6 properties 3 required
MessageHeaderAttachment
object
3 properties 1 required
NextPage
object
Specifies the paging information needed to retrieve the next set of results in a paginated API response
2 properties 1 required
Paging
object
2 properties
PreResolvedContact
object
2 properties 2 required
PreResolvedContacts
object
1 property 1 required
PreviousPage
object
specifies the paging information needed to retrieve the previous set of results in a paginated API response
2 properties 1 required
PublicChannelAccount
object
10 properties 8 required
PublicChannelAccountEgg
object
4 properties 3 required
PublicChannelAccountStagingToken
object
7 properties 5 required
PublicChannelAccountStagingTokenUpdateRequest
object
2 properties
PublicChannelAccountUpdateRequest
object
2 properties
PublicChannelIntegrationChannel
object
8 properties 4 required
PublicChannelIntegrationChannelCreate
object
6 properties 2 required
PublicChannelIntegrationChannelPatch
object
6 properties 6 required
PublicChannelIntegrationMessageUpdateRequest
object
2 properties 1 required
PublicClient
object
2 properties 1 required
PublicContact
object
2 properties 2 required
PublicConversationsMessage
object
20 properties 15 required
PublicDeliveryIdentifier
object
2 properties 2 required
PublicFile
object
5 properties 3 required
PublicLocation
object
6 properties 3 required
PublicMessageFailureDetails
object
2 properties 1 required
PublicMessageHeader
object
3 properties 1 required
PublicMessageStatus
object
2 properties 1 required
PublicQuickReplies
object
4 properties 4 required
PublicRecipient
object
4 properties 1 required
PublicSender
object
4 properties
PublicSocialMetadataAttachment
object
2 properties 2 required
PublicUnsupportedContent
object
1 property 1 required
PublicWhatsAppTemplateMetadata
object
6 properties 3 required
QuickRepliesAttachment
object
2 properties 2 required
QuickReply
object
3 properties 2 required
SocialMetadata
object
7 properties 1 required
SocialMetadataIntegrationAttachment
object
2 properties 2 required
UnsupportedContentAttachment
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-conversations-custom-channels-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API
HubSpot Workflows API
Where this information came from

This is an independent, third-party profile of HubSpot Conversations Custom Channels 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.