HubSpot Conversations Custom Channels API

openapi: 3.0.1
info:
  title: HubSpot Conversations Custom Channels
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: Allow admins to install an integration with a third-party messaging channel
    that your team uses to communicate with customers, to allow users in your account to manage their
    conversations for that channel directly in HubSpot.
  x-hubspot-introduction: 'Use the custom channels API to create custom channels to build a bridge between
    an external message service and HubSpot''s inbox or help desk features. '
servers:
- url: https://api.hubapi.com
tags:
- name: Basic
- name: Channel accounts
- name: Channels
- name: Messages
paths:
  /conversations/custom-channels/2026-09:
    get:
      tags:
      - Basic
      operationId: get-/conversations/custom-channels/2026-09_/conversations/custom-channels/v3
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as
          the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: defaultPageLength
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalPublicChannelIntegrationChannel'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security: []
    post:
      tags:
      - Basic
      operationId: post-/conversations/custom-channels/2026-09_/conversations/custom-channels/v3
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelIntegrationChannelCreate'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelIntegrationChannel'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security: []
  /conversations/custom-channels/2026-09/{channelId}:
    get:
      tags:
      - Channels
      summary: Get a custom channel
      description: Retrieve the details about a custom channel. This API allows you to see a custom channel's
        current capabilties and other configuration metadata
      operationId: get-/conversations/custom-channels/2026-09/{channelId}
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelIntegrationChannel'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security: []
    delete:
      tags:
      - Channels
      summary: Archive a custom channel
      description: Archive an existing registered custom channel
      operationId: delete-/conversations/custom-channels/2026-09/{channelId}
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security: []
    patch:
      tags:
      - Channels
      summary: Update a custom channel
      description: Update the capabilities for an existing. You can also use it to update the channel's
        webhookUri and its channelAccountConnectionRedirectUrl.
      operationId: patch-/conversations/custom-channels/2026-09/{channelId}
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelIntegrationChannelPatch'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelIntegrationChannel'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security: []
  /conversations/custom-channels/2026-09/{channelId}/channel-account-staging-tokens/{accountToken}:
    patch:
      tags:
      - Channel accounts
      summary: Update a channel account staging token
      description: Update a channel account staging token's account name and delivery identifier. This
        information will be applied to the channel account created from this staging token. This is used
        for public apps.
      operationId: patch-/conversations/custom-channels/2026-09/{channelId}/channel-account-staging-tokens/{accountToken}
      parameters:
      - name: accountToken
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelAccountStagingTokenUpdateRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelAccountStagingToken'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
      - oauth2:
        - conversations.custom_channels.write
  /conversations/custom-channels/2026-09/{channelId}/channel-accounts:
    get:
      tags:
      - Channel accounts
      summary: Get accounts for a channel
      description: Retrieve a list of accounts for a custom channel.
      operationId: get-/conversations/custom-channels/2026-09/{channelId}/channel-accounts
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as
          the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: defaultPageLength
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: deliveryIdentifierType
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - HS_EMAIL_ADDRESS
            - HS_PHONE_NUMBER
            - HS_SHORT_CODE
            - CHANNEL_SPECIFIC_OPAQUE_ID
      - name: deliveryIdentifierValue
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalPublicChannelAccount'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
      - oauth2:
        - conversations.custom_channels.write
    post:
      tags:
      - Channel accounts
      summary: Create a channel account
      description: Create a new account for a channel. Multiple accounts can communicate over a single
        channel using different delivery identifiers.
      operationId: post-/conversations/custom-channels/2026-09/{channelId}/channel-accounts
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelAccountEgg'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelAccount'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
      - oauth2:
        - conversations.custom_channels.write
  /conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}:
    get:
      tags:
      - Channels
      summary: Get a channel account by id
      description: 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.
      operationId: get-/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}
      parameters:
      - name: channelAccountId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelAccount'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
      - oauth2:
        - conversations.custom_channels.write
    patch:
      tags:
      - Channel accounts
      summary: Update a channel account
      description: This API is used to update the name of the channel account and it's isAuthorized status.
        Setting to isAuthorized flag to False disables the channel account.
      operationId: patch-/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}
      parameters:
      - name: channelAccountId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelAccountUpdateRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicChannelAccount'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
      - oauth2:
        - conversations.custom_channels.write
  /conversations/custom-channels/2026-09/{channelId}/messages:
    post:
      tags:
      - Messages
      summary: Publish a message
      description: Publish a message over your custom channel
      operationId: post-/conversations/custom-channels/2026-09/{channelId}/messages
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelIntegrationMessageEgg'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicConversationsMessage'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.write
  /conversations/custom-channels/2026-09/{channelId}/messages/{messageId}:
    get:
      tags:
      - Messages
      summary: Get a message
      description: Get the details for a specific message sent over a custom channel
      operationId: get-/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: messageId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicConversationsMessage'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.read
    patch:
      tags:
      - Messages
      summary: 'Update a message '
      description: Update a message's status to indicate if it was successfully sent, failed to send,
        or was read. For failed messages, this can also include the error message for the failure.
      operationId: patch-/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
      parameters:
      - name: channelId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: messageId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicChannelIntegrationMessageUpdateRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicConversationsMessage'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.custom_channels.write
components:
  schemas:
    ChannelIntegrationMessageEgg:
      required:
      - attachments
      - channelAccountId
      - messageDirection
      - recipients
      - senders
      - text
      - timestamp
      type: object
      properties:
        associateWithContactId:
          type: integer
          format: int64
        attachments:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/FileAttachment'
            - $ref: '#/components/schemas/LocationAttachment'
            - $ref: '#/components/schemas/ContactAttachment'
            - $ref: '#/components/schemas/UnsupportedContentAttachment'
            - $ref: '#/components/schemas/MessageHeaderAttachment'
            - $ref: '#/components/schemas/QuickRepliesAttachment'
            - $ref: '#/components/schemas/SocialMetadataIntegrationAttachment'
        channelAccountId:
          type: string
        inReplyToId:
          type: string
        integrationIdempotencyId:
          type: string
        integrationThreadId:
          type: string
        messageDirection:
          type: string
          enum:
          - INCOMING
          - OUTGOING
        preResolvedContacts:
          $ref: '#/components/schemas/PreResolvedContacts'
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/ChannelIntegrationParticipant'
        richText:
          type: string
        senders:
          type: array
          items:
            $ref: '#/components/schemas/ChannelIntegrationParticipant'
        text:
          type: string
        timestamp:
          type: string
          format: date-time
    ChannelIntegrationParticipant:
      required:
      - deliveryIdentifier
      type: object
      properties:
        deliveryIdentifier:
          $ref: '#/components/schemas/PublicDeliveryIdentifier'
        name:
          type: string
        senderActorId:
          type: string
    CollectionResponseWithTotalPublicChannelAccount:
      required:
      - results
      - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/PublicChannelAccount'
        total:
          type: integer
          format: int32
    CollectionResponseWithTotalPublicChannelIntegrationChannel:
      required:
      - results
      - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/PublicChannelIntegrationChannel'
        total:
          type: integer
          format: int32
    ContactAddress:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        countryCode:
          type: string
        state:
          type: string
        street:
          type: string
        type:
          type: string
          enum:
          - HOME
          - WORK
        zip:
          type: string
    ContactAttachment:
      title: CONTACT
      required:
      - contactProfile
      - type
      type: object
      properties:
        contactProfile:
          $ref: '#/components/schemas/ContactProfile'
        type:
          type: string
          default: CONTACT
          enum:
          - CONTACT
      x-hubspot-sub-type-impl: true
    ContactEmail:
      required:
      - email
      type: object
      properties:
        email:
          type: string
        type:
          type: string
          enum:
          - HOME
          - WORK
    ContactName:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        middleName:
          type: string
        prefix:
          type: string
        suffix:
          type: string
    ContactOrg:
      type: object
      properties:
        company:
          type: string
        department:
          type: string
        title:
          type: string
    ContactPhone:
      required:
      - phone
      type: object
      properties:
        phone:
          type: string
        type:
          type: string
          enum:
          - CELL
          - HOME
          - MAIN
          - WORK
    ContactProfile:
      required:
      - addresses
      - emails
      - phones
      - urls
      type: object
      properties:
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/ContactAddress'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/ContactEmail'
        name:
          $ref: '#/components/schemas/ContactName'
        org:
          $ref: '#/components/schemas/ContactOrg'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/ContactPhone'
        urls:
          type: array
          items:
            $ref: '#/components/schemas/ContactUrl'
    ContactUrl:
      required:
      - url
      type: object
      properties:
        type:
          type: string
          enum:
          - HOME
          - WORK
        url:
          type: string
    Error:
      required:
      - category
      - correlationId
      - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}'
        correlationId:
          type: string
          description: A unique identifier for the request. Include this value with any error reports
            or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: A map of link names to associated URIs containing documentation about the error
            or recommended remediation steps
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
          example: An error occurred
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: 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 error encountered.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
      - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents detailed information about an error that occurred in the API. This component
        is used to provide additional context and specifics about errors, typically as part of an error
        response.
    FileAttachment:
      title: FILE
      required:
      - fileId
      - type
      type: object
      properties:
        fileId:
          type: string
        fileUsageType:
          type: string
          enum:
          - AUDIO
          - IMAGE
          - OTHER
          - STICKER
          - VOICE_RECORDING
        type:
          type: string
          default: FILE
          enum:
          - FILE
      x-hubspot-sub-type-impl: true
    LocationAttachment:
      title: LOCATION
      required:
      - latitude
      - longitude
      - type
      type: object
      properties:
        address:
          type: string
        latitude:
          type: number
        longitude:
          type: number
        name:
          type: string
        type:
          type: string
          default: LOCATION
          enum:
          - LOCATION
        url:
          type: string
      x-hubspot-sub-type-impl: true
    MessageHeaderAttachment:
      title: MESSAGE_HEADER
      required:
      - type
      type: object
      properties:
        fileId:
          type: integer
          format: int64
        text:
          type: string
        type:
          type: string
          default: MESSAGE_HEADER
          enum:
          - MESSAGE_HEADER
      x-hubspot-sub-type-impl: true
    NextPage:
      required:
      - after
      type: object
      properties:
        after:
          type: string
          description: A paging cursor token for retrieving subsequent pages.
        link:
          type: string
          description: A URL that can be used to retrieve the next page results.
      description: Specifies the paging information needed to retrieve the next set of results in a paginated
        API response
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
    PreResolvedContact:
      required:
      - contactPropertiesLeadingToMatch
      - contactVid
      type: object
      properties:
        contactPropertiesLeadingToMatch:
          type: array
          items:
            type: string
            enum:
            - address
            - annualrevenue
            - associatedcompanyid
            - associatedcompanylastupdated
            - city
            - closedate
            - company
            - company_size
            - country
            - createdate
            - currentlyinworkflow
            - date_of_birth
            - days_to_close
            - degree
            - email
            - engagements_last_meeting_booked
            - engagements_last_meeting_booked_campaign
            - engagements_last_meeting_booked_medium
            - engagements_last_meeting_booked_source
            - fax
            - field_of_study
            - first_conversion_date
            - first_conversion_event_name
            - first_deal_created_date
            - firstname
            - followercount
            - gender
            - graduation_date
            - hs_active_contracts_arr
            - hs_active_contracts_mrr
            - hs_active_contracts_tcv
            - hs_additional_emails
            - hs_all_contact_vids
            - hs_analytics_average_page_views
            - hs_analytics_first_referrer
            - hs_analytics_first_timestamp
            - hs_analytics_first_touch_converting_campaign
            - hs_analytics_first_url
            - hs_analytics_first_visit_timestamp
            - hs_analytics_last_referrer
            - hs_analytics_last_timestamp
            - hs_analytics_last_touch_converting_campaign
            - hs_analytics_last_url
            - hs_analytics_last_visit_timestamp
            - hs_analytics_num_event_completions
            - hs_analytics_num_page_views
            - hs_analytics_num_visits
            - hs_analytics_revenue
            - hs_analytics_source
            - hs_analytics_source_composite_data
            - hs_analytics_source_data_1
            - hs_analytics_source_data_2
            - hs_associated_target_accounts
            - hs_avatar_filemanager_key
            - hs_bing_ad_clicked
            - hs_bing_click_id
            - hs_buying_role
            - hs_calculated_form_submissions
            - hs_calculated_merged_vids
            - hs_calculated_mobile_number
            - hs_calculated_phone_number
            - hs_calculated_phone_number_area_code
            - hs_calculated_phone_number_country_code
            - hs_calculated_phone_number_region_code
            - hs_chat_assistant_iql_date
            - hs_chat_assistant_source
            - hs_chat_assistant_summary
            - hs_chatgpt_ad_clicked
            - hs_chatgpt_click_id
            - hs_clicked_linkedin_ad
            - hs_consent_to_email_tracking
            - hs_contact_creation_legal_basis_source_instance_id
            - hs_contact_enrichment_opt_out
            - hs_contact_enrichment_opt_out_timestamp
            - hs_content_membership_email
            - hs_content_membership_email_confirmed
            - hs_content_membership_follow_up_enqueued_at
            - hs_content_membership_notes
            - hs_content_membership_registered_at
            - hs_content_membership_registration_domain_sent_to
            - hs_content_membership_registration_email_sent_at
            - hs_content_membership_status
            - hs_conversations_visitor_email
            - hs_count_is_unworked
            - hs_count_is_worked
            - hs_country_region_code
            - hs_created_by_conversations
            - hs_cross_account_note
            - hs_cross_sell_opportunity
            - hs_current_customer
            - hs_currently_enrolled_in_prospecting_agent
            - hs_customer_agent_lead_status
            - hs_data_privacy_ads_consent
            - hs_date_entered_customer
            - hs_date_entered_evangelist
  

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/openapi/hubspot-conversations-custom-channels-api-openapi.yml