# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubspot Channels API
  version: 1.0.0
extends: openapi/hubspot-channels-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/conversations/v3/conversations/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation channels
      effect: read
      questions:
      - What conversation channels are available in my HubSpot inbox setup?
      - Can I page through the list of messaging channels and sort them?
      - Which channels can conversations come in through?
      instructions:
      - text: List all conversation channels.
      - text: Show me {limit} conversation channels per page, sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      - text: Get the next page of channels after cursor {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/channels/{channelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation channel's details
      effect: read
      questions:
      - How do I look up a single conversations channel by its ID?
      - What are the details of the channel a conversation came in on?
      instructions:
      - text: Get conversation channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Show the details of inbox channel {channelId} from the conversations channel list.
        slots:
          channelId: path.channelId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom channel's capabilities and settings
      effect: read
      questions:
      - What capabilities does my registered custom messaging channel currently support?
      - How can I check the configuration of a custom channel my app registered?
      instructions:
      - text: Get custom channel {channelId} with its capabilities and metadata.
        slots:
          channelId: path.channelId
      - text: Show the current configuration of my app's custom channel {channelId}.
        slots:
          channelId: path.channelId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a custom messaging channel
      effect: destructive
      questions:
      - How do I retire a custom channel my app registered?
      - Can I archive a custom messaging channel I no longer support?
      instructions:
      - text: Archive custom channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Unregister my app's custom messaging channel {channelId}.
        slots:
          channelId: path.channelId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom channel's capabilities and URLs
      effect: write
      questions:
      - How do I change the webhook URL for my custom messaging channel?
      - Can I update a custom channel's capabilities, name and logo after registering it?
      - Where do I set the redirect URL used when a channel account is connected?
      instructions:
      - text: Point custom channel {channelId}'s webhook at {webhookUrl}.
        slots:
          channelId: path.channelId
          webhookUrl: requestBody.webhookUrl
      - text: Update custom channel {channelId} to name {name}, description {channelDescription} and logo {channelLogoUrl}.
        slots:
          channelId: path.channelId
          name: requestBody.name
          channelDescription: requestBody.channelDescription
          channelLogoUrl: requestBody.channelLogoUrl
      - text: Set custom channel {channelId}'s capabilities to {capabilities} and its account connection redirect to {channelAccountConnectionRedirectUrl}.
        slots:
          channelId: path.channelId
          capabilities: requestBody.capabilities
          channelAccountConnectionRedirectUrl: requestBody.channelAccountConnectionRedirectUrl
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom channel account's details
      effect: read
      questions:
      - Which inbox is a custom channel account connected to?
      - How do I see the delivery identifier for a specific channel account?
      - Can I still look up a channel account that has been archived?
      instructions:
      - text: Get channel account {channelAccountId} on custom channel {channelId}.
        slots:
          channelAccountId: path.channelAccountId
          channelId: path.channelId
      - text: 'Look up channel account {channelAccountId} on custom channel {channelId}, archived only: {archived}.'
        slots:
          channelAccountId: path.channelAccountId
          channelId: path.channelId
          archived: query.archived
      method: generated
      generated: '2026-09-24'