HubSpot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversations Inbox & Messages Threads API

7 actions 7 updates phrasing extends openapi/hubspot-threads-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for HubSpot's API. It is a proposal applied on top of the contract, not a document HubSpot publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/conversations/v3/conversations/threads'].get
$.paths['/conversations/v3/conversations/threads/{threadId}'].get
$.paths['/conversations/v3/conversations/threads/{threadId}'].delete
$.paths['/conversations/v3/conversations/threads/{threadId}'].patch
$.paths['/conversations/v3/conversations/threads/{threadId}/messages'].get
$.paths['/conversations/v3/conversations/threads/{threadId}/messages'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conversations Inbox & Messages Threads API
  version: 1.0.0
extends: openapi/hubspot-threads-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/threads'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation threads
      effect: read
      questions:
      - How do I list the conversation threads in a specific inbox?
      - Can I filter threads down to only open or only closed ones?
      - Is there a way to get only threads with a new message after a certain time?
      instructions:
      - text: List threads in inbox {inboxId}.
        slots:
          inboxId: query.inboxId
      - text: Show {threadStatus} threads for contact {associatedContactId}.
        slots:
          threadStatus: query.threadStatus
          associatedContactId: query.associatedContactId
      - text: List threads with messages after {latestMessageTimestampAfter}.
        slots:
          latestMessageTimestampAfter: query.latestMessageTimestampAfter
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one conversation thread
      effect: read
      questions:
      - What details can I see about a single conversation thread?
      - Can I fetch a thread that has already been archived?
      instructions:
      - text: Get thread {threadId}.
        slots:
          threadId: path.threadId
      - text: Look up conversation thread {threadId} and its current status.
        slots:
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a conversation thread
      effect: destructive
      questions:
      - What happens to a conversation thread after I archive it?
      - Can I archive a thread so it gets permanently deleted after 30 days?
      instructions:
      - text: Archive thread {threadId}.
        slots:
          threadId: path.threadId
      - text: Move conversation {threadId} to the archive for deletion in 30 days.
        slots:
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Close, reopen or restore a thread
      effect: write
      questions:
      - How do I mark a conversation thread as closed?
      - Can I restore a thread I archived by mistake?
      instructions:
      - text: Set thread {threadId} to {status}.
        slots:
          threadId: path.threadId
          status: requestBody.status
      - text: Restore archived thread {threadId}.
        slots:
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a thread's message history
      effect: read
      questions:
      - Where can I read every message exchanged in a conversation thread?
      - Can I page through a long thread's message history?
      instructions:
      - text: Show the message history for thread {threadId}.
        slots:
          threadId: path.threadId
      - text: Get {limit} messages from thread {threadId}.
        slots:
          limit: query.limit
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/conversations/v3/conversations/threads/{threadId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message on a thread
      effect: write
      questions:
      - Can I reply to a customer conversation thread through the API?
      - Does a message I send to a thread get stamped with the current time?
      instructions:
      - text: Send a message on thread {threadId}.
        slots:
          threadId: path.threadId
      - text: Post a reply into conversation thread {threadId}.
        slots:
          threadId: path.threadId
      method: generated
      generated: '2026-09-24'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/hubspot-threads-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.