# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubspot Messages API
  version: 1.0.0
extends: openapi/hubspot-messages-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: 5
- target: $.paths['/conversations/v3/conversations/threads/{threadId}/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message from a conversation thread
      effect: read
      questions:
      - How do I read one specific message inside an inbox conversation thread?
      - Can I fetch a single message from a thread when I know both IDs?
      instructions:
      - text: Get message {messageId} from conversation thread {threadId}.
        slots:
          messageId: path.messageId
          threadId: path.threadId
      - text: Show the {property} of message {messageId} in thread {threadId}.
        slots:
          property: query.property
          messageId: path.messageId
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message's full untruncated content
      effect: read
      questions:
      - A conversation message looks cut off; how can I get its complete original text?
      - Where do I find the full rich-text body of a truncated message?
      instructions:
      - text: Get the full original content of message {messageId} in thread {threadId}.
        slots:
          messageId: path.messageId
          threadId: path.threadId
      - text: Fetch the untruncated text and rich text of message {messageId} from thread {threadId}.
        slots:
          messageId: path.messageId
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a message over a custom channel
      effect: write
      questions:
      - How do I send an incoming or outgoing message into HubSpot through my custom channel?
      - Can I thread a custom channel message as a reply to an earlier message?
      instructions:
      - text: Publish the message {text} on custom channel {channelId} from channel account {channelAccountId}.
        slots:
          text: requestBody.text
          channelId: path.channelId
          channelAccountId: requestBody.channelAccountId
      - text: Post {text} to custom channel {channelId} as a reply to message {inReplyToId}.
        slots:
          text: requestBody.text
          channelId: path.channelId
          inReplyToId: requestBody.inReplyToId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message sent over a custom channel
      effect: read
      questions:
      - How can I look up a message that went through my custom channel?
      - What details are stored for a specific custom channel message?
      instructions:
      - text: Get message {messageId} from custom channel {channelId}.
        slots:
          messageId: path.messageId
          channelId: path.channelId
      - text: Show the details of custom channel {channelId} message {messageId}.
        slots:
          channelId: path.channelId
          messageId: path.messageId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom channel message's delivery status
      effect: write
      questions:
      - How do I mark a custom channel message as sent, failed or read?
      - Can I record why a message failed to send on my custom channel?
      instructions:
      - text: Set the status of message {messageId} on custom channel {channelId} to {statusType}.
        slots:
          messageId: path.messageId
          channelId: path.channelId
          statusType: requestBody.statusType
      - text: Mark custom channel {channelId} message {messageId} as failed with error {errorMessage}.
        slots:
          channelId: path.channelId
          messageId: path.messageId
          errorMessage: requestBody.errorMessage
      method: generated
      generated: '2026-09-24'