# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubspot Channel accounts API
  version: 1.0.0
extends: openapi/hubspot-channel-accounts-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/channel-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel accounts across inboxes
      effect: read
      questions:
      - Which channel accounts are connected to my conversations inboxes?
      - Can I filter all my channel accounts by inbox?
      instructions:
      - text: List channel accounts in inbox {inboxId}.
        slots:
          inboxId: query.inboxId
      - text: Show all connected channel accounts, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/channel-accounts/{channelAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one channel account
      effect: read
      questions:
      - How do I look up a single channel account by its ID?
      - Can I see the details of a channel account even if it's archived?
      instructions:
      - text: Get channel account {channelAccountId}.
        slots:
          channelAccountId: path.channelAccountId
      - text: Show the details of channel account {channelAccountId}.
        slots:
          channelAccountId: path.channelAccountId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/channel-account-staging-tokens/{accountToken}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a channel account staging token
      effect: write
      questions:
      - Can I set the account name on a staging token before its channel account is created?
      - How does a public app set the delivery identifier for a channel account that doesn't exist yet?
      instructions:
      - text: Rename staging token {accountToken} on channel {channelId} to {accountName}.
        slots:
          accountToken: path.accountToken
          channelId: path.channelId
          accountName: requestBody.accountName
      - text: Set delivery identifier {deliveryIdentifier} on staging token {accountToken} for channel {channelId}.
        slots:
          deliveryIdentifier: requestBody.deliveryIdentifier
          accountToken: path.accountToken
          channelId: path.channelId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/channel-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts on a custom channel
      effect: read
      questions:
      - Can I list every account connected to one of my custom channels?
      - Is it possible to find a custom channel account by its delivery identifier value?
      instructions:
      - text: List accounts on custom channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Find the account on custom channel {channelId} with delivery identifier {deliveryIdentifierValue}.
        slots:
          channelId: path.channelId
          deliveryIdentifierValue: query.deliveryIdentifierValue
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/channel-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account on a custom channel
      effect: write
      questions:
      - How do I add a new account to a custom channel?
      - Can several accounts share one custom channel by using different delivery identifiers?
      instructions:
      - text: Create account {name} on custom channel {channelId} in inbox {inboxId}.
        slots:
          name: requestBody.name
          channelId: path.channelId
          inboxId: requestBody.inboxId
      - text: Add account {name} to channel {channelId}, routed to inbox {inboxId}, with delivery identifier {deliveryIdentifier}.
        slots:
          name: requestBody.name
          channelId: path.channelId
          inboxId: requestBody.inboxId
          deliveryIdentifier: requestBody.deliveryIdentifier
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/channel-accounts/{channelAccountId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or disable a custom channel account
      effect: write
      questions:
      - Can I disable a custom channel account without deleting it?
      - What's the way to rename an existing account on a custom channel?
      instructions:
      - text: Rename account {channelAccountId} on channel {channelId} to {name}.
        slots:
          channelAccountId: path.channelAccountId
          channelId: path.channelId
          name: requestBody.name
      - text: Set authorized to {authorized} for account {channelAccountId} on custom channel {channelId}.
        slots:
          authorized: requestBody.authorized
          channelAccountId: path.channelAccountId
          channelId: path.channelId
      method: generated
      generated: '2026-09-24'