Channels

Get a channel account by id

Changed on

Retrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.

get/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesconversations.custom_channels.read
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesconversations.custom_channels.write

Path parameters

channelAccountIdinteger required
channelIdinteger required

Query parameters

archivedboolean

Whether to return only results that have been archived.

Response

successful operation

activeboolean required
archivedboolean required
archivedAtstring date-time
authorizedboolean required
channelIdstring required
createdAtstring date-time required
idstring required
inboxIdstring required
namestring required

Changes

    • info

      the security scope conversations.custom_channels.read was added to the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.write was removed from the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.read was added to the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.write was removed from the endpoint's security scheme oauth2