HubSpot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hubspot Basic API

484 actions 484 updates phrasing extends openapi/hubspot-basic-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 484 · first 16 shown; the file carries all of them

$.info
$.paths['/account-info/2026-09/activity/audit-logs'].get
$.paths['/account-info/2026-09/activity/login'].get
$.paths['/account-info/2026-09/activity/security'].get
$.paths['/account-info/2026-09/api-usage/daily/private-apps'].get
$.paths['/account-info/2026-09/details'].get
$.paths['/automation/email-templates/2026-09'].get
$.paths['/automation/email-templates/2026-09'].post
$.paths['/automation/email-templates/2026-09/folders'].get
$.paths['/automation/email-templates/2026-09/{templateId}'].get
$.paths['/automation/email-templates/2026-09/{templateId}'].patch
$.paths['/automation/sequences/2026-03'].get
$.paths['/automation/sequences/2026-03/enrollments'].post
$.paths['/automation/sequences/2026-03/enrollments/contact/{contactId}'].get
$.paths['/automation/sequences/2026-03/{sequenceId}'].get
$.paths['/business-units/public/2026-09/business-units/user/{userId}'].get

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 Hubspot Basic API
  version: 1.0.0
extends: openapi/hubspot-basic-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: 483
- target: $.paths['/account-info/2026-09/activity/audit-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Review account audit logs of user actions
      effect: read
      questions:
      - Who changed what in my HubSpot account last week?
      - Can I filter the account audit trail to actions taken by one specific user?
      - Is there a way to see user activity logs between two dates for a compliance review?
      instructions:
      - text: Show me the account audit log for user actions since {occurredAfter}.
        slots:
          occurredAfter: query.occurredAfter
      - text: Pull audit log entries for actions taken by user {actingUserId}.
        slots:
          actingUserId: query.actingUserId
      - text: List account audit events that happened before {occurredBefore}.
        slots:
          occurredBefore: query.occurredBefore
      method: generated
      generated: '2026-09-24'
- target: $.paths['/account-info/2026-09/activity/login'].get
  update:
    x-apievangelist-phrasing:
      intent: See user login history for the account
      effect: read
      questions:
      - When did each person last log in to our portal?
      - Can I see the login history for a single user?
      instructions:
      - text: List recent logins to the account.
      - text: Show the login history for user {userId}.
        slots:
          userId: query.userId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/account-info/2026-09/activity/security'].get
  update:
    x-apievangelist-phrasing:
      intent: Review security activity in the account
      effect: read
      questions:
      - What security events have happened in my account recently?
      - Can I check security activity for one user over a date range?
      instructions:
      - text: Show security activity for user {userId}.
        slots:
          userId: query.userId
      - text: List security events between {fromTimestamp} and {toTimestamp}.
        slots:
          fromTimestamp: query.fromTimestamp
          toTimestamp: query.toTimestamp
      method: generated
      generated: '2026-09-24'
- target: $.paths['/account-info/2026-09/api-usage/daily/private-apps'].get
  update:
    x-apievangelist-phrasing:
      intent: Check daily API usage for private apps
      effect: read
      questions:
      - How many API calls have my private apps made today?
      - Am I close to the daily API limit with my private apps?
      instructions:
      - text: Show today's API call usage for our private apps.
      - text: Report the daily private app API consumption for the account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/account-info/2026-09/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account details like time zone and currency
      effect: read
      questions:
      - What time zone and currency is my HubSpot account set to?
      - Where is my account's data hosted?
      instructions:
      - text: Show my account's details, including account type and data hosting location.
      - text: Look up the portal's configured time zone and company currency.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/email-templates/2026-09'].get
  update:
    x-apievangelist-phrasing:
      intent: List sequence email templates
      effect: read
      questions:
      - Which email templates do I have for automated sequences?
      - Can I page through all my sequence email templates?
      instructions:
      - text: List my sequence email templates.
      - text: Show the first {limit} automation email templates.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/email-templates/2026-09'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sequence email template
      effect: write
      questions:
      - Can I create a new email template for sequences through the API?
      - What do I need to supply to add an automation email template?
      instructions:
      - text: Create an email template named {name} with body {body}.
        slots:
          name: requestBody.name
          body: requestBody.body
      - text: Add a sequence email template {name} with subject line {subject} and body {body}.
        slots:
          name: requestBody.name
          subject: requestBody.subject
          body: requestBody.body
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/email-templates/2026-09/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List email template folders
      effect: read
      questions:
      - What folders are my sequence email templates organized into?
      - Can I see the list of template folders for automation emails?
      instructions:
      - text: List the folders that hold my automation email templates.
      - text: Show {limit} email template folders at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/email-templates/2026-09/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sequence email template
      effect: read
      questions:
      - Can I pull the subject and body of one specific sequence template?
      - What does email template 123 contain?
      instructions:
      - text: Show me email template {templateId}.
        slots:
          templateId: path.templateId
      - text: Fetch the subject and body of automation template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/email-templates/2026-09/{templateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a sequence email template
      effect: write
      questions:
      - Can I change the subject line of an existing sequence template?
      - How do I move a sequence email template into another folder?
      instructions:
      - text: Update template {templateId} with subject {subject}, body {body}, name {name} and folder {folderId}.
        slots:
          templateId: path.templateId
          subject: requestBody.subject
          body: requestBody.body
          name: requestBody.name
          folderId: requestBody.folderId
      - text: Rename email template {templateId} to {name} keeping body {body}, subject {subject} and folder {folderId}.
        slots:
          templateId: path.templateId
          name: requestBody.name
          body: requestBody.body
          subject: requestBody.subject
          folderId: requestBody.folderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/sequences/2026-03'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's sales sequences
      effect: read
      questions:
      - Which sales sequences does a given user have access to?
      - Can I search a user's sequences by name?
      instructions:
      - text: List the sequences available to user {userId}.
        slots:
          userId: query.userId
      - text: Find sequences named {name} for user {userId}.
        slots:
          name: query.name
          userId: query.userId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/sequences/2026-03/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a contact in a sales sequence
      effect: write
      questions:
      - How do I enroll a contact into a sales sequence via the API?
      - Can I choose which sender email a sequence enrollment goes out from?
      instructions:
      - text: Enroll contact {contactId} in sequence {sequenceId} sending from {senderEmail} as user {userId}.
        slots:
          contactId: requestBody.contactId
          sequenceId: requestBody.sequenceId
          senderEmail: requestBody.senderEmail
          userId: query.userId
      - text: Put contact {contactId} into sequence {sequenceId}, sent by {senderEmail} via alias {senderAliasAddress}, on behalf of user {userId}.
        slots:
          contactId: requestBody.contactId
          sequenceId: requestBody.sequenceId
          senderEmail: requestBody.senderEmail
          senderAliasAddress: requestBody.senderAliasAddress
          userId: query.userId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/sequences/2026-03/enrollments/contact/{contactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a contact's sequence enrollment status
      effect: read
      questions:
      - Is this contact currently enrolled in a sequence?
      - What sequence enrollment state is a particular contact in?
      instructions:
      - text: Check the sequence enrollment status of contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Tell me whether contact {contactId} is enrolled in any sequence.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/automation/sequences/2026-03/{sequenceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one sales sequence
      effect: read
      questions:
      - What steps are in a specific sales sequence?
      - Can I look up a single sequence's details for a user?
      instructions:
      - text: Show details for sequence {sequenceId} as user {userId}.
        slots:
          sequenceId: path.sequenceId
          userId: query.userId
      - text: Get the steps and settings of sequence {sequenceId} for user {userId}.
        slots:
          sequenceId: path.sequenceId
          userId: query.userId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/business-units/public/2026-09/business-units/user/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List brands a user is associated with
      effect: read
      questions:
      - Which brands or business units is a given user assigned to?
      - Can I check a user's business units by name?
      instructions:
      - text: List the brands associated with user {userId}.
        slots:
          userId: path.userId
      - text: Show business units for user {userId} named {name}.
        slots:
          userId: path.userId
          name: query.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blogs/2026-09/authors'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog authors
      effect: read
      questions:
      - Who are all the authors on my blogs?
      - Can I list blog authors created after a certain date?
      instructions:
      - text: List all blog authors.
      - text: Show blog authors created after {createdAfter}.
        slots:
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blogs/2026-09/authors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a blog author
      effect: write
      questions:
      - How do I add a new author profile to my blog?
      - Can I set an author's bio, avatar and social links when creating them?
      instructions:
      - text: Create blog author {fullName} with email {email}, bio {bio}, slug {slug} and display name {displayName}.
        slots:
          fullName: requestBody.fullName
          email: requestBody.email
          bio: requestBody.bio
          slug: requestBody.slug
          displayName: requestBody.displayName
      - text: Add a new blog author named {name} whose website is {website}.
        slots:
          name: requestBody.name
          website: requestBody.website
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blogs/2026-09/authors/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog author
      effect: read
      questions:
      - Can I pull one blog author's profile by ID?
      - What bio and social links does a particular blog author have?
      instructions:
      - text: Show blog author {objectId}.
        slots:
          objectId: path.objectId
      - text: Fetch the profile of blog author {objectId}, including archived ones.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blogs/2026-09/authors/{objectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog author
      effect: destructive
      questions:
      - Can I remove an author from my blog?
      - What happens when I delete a blog author profile?
      instructions:
      - text: Delete blog author {objectId}.
        slots:
          objectId: path.objectId
      - text: Remove author {objectId} from the blog.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blogs/2026-09/authors/{objectId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a blog author
      effect: write
      questions:
      - Can I change an existing blog author's bio or avatar?
      - How do I update the LinkedIn link on an author profile?
      instructions:
      - text: Update blog author {objectId} to have bio {bio}.
        slots:
          objectId: path.objectId
          bio: requestBody.bio
      - text: Change the LinkedIn URL for author {objectId} to {linkedin}.
        slots:
          objectId: path.objectId
          linkedin: requestBody.linkedin
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blog-settings/2026-09/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List all blogs in the account
      effect: read
      questions:
      - What blogs exist in my CMS?
      - Can I list the blogs updated since a certain date?
      instructions:
      - text: List every blog in my account with its settings.
      - text: Show blogs updated after {updatedAfter}.
        slots:
          updatedAfter: query.updatedAfter
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/blog-settings/2026-09/settings/{blogId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one blog's settings
      effect: read
      questions:
      - What are the settings for a specific blog?
      - Can I look up one blog by its ID?
      instructions:
      - text: Show the settings for blog {blogId}.
        slots:
          blogId: path.blogId
      - text: Get blog {blogId} configuration.
        slots:
          blogId: path.blogId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/audit-logs/2026-09'].get
  update:
    x-apievangelist-phrasing:
      intent: Review CMS content change audit logs
      effect: read
      questions:
      - Who edited or published content on my website recently?
      - Can I filter CMS audit logs by event type or object type?
      instructions:
      - text: Show CMS audit log entries for object {objectId}.
        slots:
          objectId: query.objectId
      - text: List CMS content changes made by user {userId}.
        slots:
          userId: query.userId
      - text: Find CMS audit events of type {eventType}.
        slots:
          eventType: query.eventType
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/domains/2026-09'].get
  update:
    x-apievangelist-phrasing:
      intent: List website domains connected to the CMS
      effect: read
      questions:
      - Which domains are connected to my website?
      - Can I list the archived domains too?
      instructions:
      - text: List all domains connected to my CMS.
      - text: Show CMS domains created after {createdAfter}.
        slots:
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/domains/2026-09/{domainId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one connected domain
      effect: read
      questions:
      - Can I look up the setup of one specific domain?
      - Is a particular domain configured correctly for my site?
      instructions:
      - text: Show details for domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Get the configuration of connected domain {domainId}.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties of a media bridge object type
      effect: read
      questions:
      - What properties exist on my media bridge app's video objects?
      - Can I include archived properties when listing a media object type's fields?
      instructions:
      - text: List properties for media object type {objectType} in app {appId}.
        slots:
          objectType: path.objectType
          appId: path.appId
      - text: Show archived media bridge properties on {objectType} for app {appId}.
        slots:
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a media bridge property
      effect: write
      questions:
      - Can I add a custom field to a media bridge object type?
      - What's required to define a new property on my app's media objects?
      instructions:
      - text: Create property {name} labelled {label} of type {type} and field type {fieldType} in group {groupName} on {objectType} for app {appId}.
        slots:
          name: requestBody.name
          label: requestBody.label
          type: requestBody.type
          fieldType: requestBody.fieldType
          groupName: requestBody.groupName
          objectType: path.objectType
          appId: path.appId
      - text: Add a media property {name} ({label}, {type}/{fieldType}) to group {groupName} of {objectType} in app {appId}.
        slots:
          name: requestBody.name
          label: requestBody.label
          type: requestBody.type
          fieldType: requestBody.fieldType
          groupName: requestBody.groupName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List property groups for a media object type
      effect: read
      questions:
      - Which property groups exist on my media bridge object type?
      - How are my media object properties grouped?
      instructions:
      - text: List property groups on {objectType} for app {appId}.
        slots:
          objectType: path.objectType
          appId: path.appId
      - text: Show the media bridge property groups of app {appId} for {objectType}.
        slots:
          appId: path.appId
          objectType: path.objectType
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a media bridge property group
      effect: write
      questions:
      - Can I create a new group to organize media object properties?
      - What do I need to add a property group to a media object type?
      instructions:
      - text: Create property group {name} labelled {label} on {objectType} for app {appId}.
        slots:
          name: requestBody.name
          label: requestBody.label
          objectType: path.objectType
          appId: path.appId
      - text: Add a group {name} with label {label} at display order {displayOrder} to {objectType} in app {appId}.
        slots:
          name: requestBody.name
          label: requestBody.label
          displayOrder: requestBody.displayOrder
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a media bridge property group
      effect: read
      questions:
      - Can I look up one property group on a media object type?
      - What label and order does a specific media property group have?
      instructions:
      - text: Show property group {groupName} on {objectType} in app {appId}.
        slots:
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
      - text: Get media group {groupName} details for object type {objectType}, app {appId}.
        slots:
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media bridge property group
      effect: destructive
      questions:
      - Can I remove a property group from a media object type?
      - What happens to a media property group once I delete it?
      instructions:
      - text: Delete property group {groupName} from {objectType} in app {appId}.
        slots:
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
      - text: Remove the media group {groupName} on {objectType} for app {appId}.
        slots:
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a media bridge property group
      effect: write
      questions:
      - Can I relabel an existing media property group?
      - Is it possible to change a property group's display order?
      instructions:
      - text: Relabel property group {groupName} on {objectType} in app {appId} to {label}.
        slots:
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
          label: requestBody.label
      - text: Set display order {displayOrder} on media group {groupName} of {objectType} for app {appId}.
        slots:
          displayOrder: requestBody.displayOrder
          groupName: path.groupName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a media bridge property
      effect: read
      questions:
      - What type and options does one media object property have?
      - Can I fetch a single property definition from my media bridge app?
      instructions:
      - text: Show property {propertyName} on {objectType} in app {appId}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
      - text: Get the definition of media property {propertyName} for {objectType}, app {appId}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media bridge property
      effect: destructive
      questions:
      - Can I remove a custom property from a media object type?
      - Does deleting a media bridge property remove it from the object type?
      instructions:
      - text: Delete property {propertyName} from {objectType} in app {appId}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
      - text: Remove media property {propertyName} on object type {objectType} for app {appId}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a media bridge property
      effect: write
      questions:
      - Can I change the label or options of an existing media property?
      - How do I hide a media bridge property from forms?
      instructions:
      - text: Relabel media property {propertyName} on {objectType} in app {appId} to {label}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
          label: requestBody.label
      - text: Move property {propertyName} of {objectType} in app {appId} into group {groupName}.
        slots:
          propertyName: path.propertyName
          objectType: path.objectType
          appId: path.appId
          groupName: requestBody.groupName
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List media bridge object schemas
      effect: read
      questions:
      - Which media object schemas has my app defined?
      - Can I see archived media bridge schemas as well?
      instructions:
      - text: List the object schemas defined by app {appId}.
        slots:
          appId: path.appId
      - text: Show all media bridge schemas for app {appId}, including archived.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/schemas/{objectType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one media bridge object schema
      effect: read
      questions:
      - What does the schema for my app's video object type look like?
      - Can I retrieve one media object schema with its properties?
      instructions:
      - text: Show the schema for {objectType} in app {appId}.
        slots:
          objectType: path.objectType
          appId: path.appId
      - text: Get media object schema {objectType} defined by app {appId}.
        slots:
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/schemas/{objectType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a media bridge object schema
      effect: write
      questions:
      - Can I change which properties are searchable on a media object schema?
      - How do I set the primary display property on my media schema?
      instructions:
      - text: Set the primary display property of {objectType} in app {appId} to {primaryDisplayProperty}.
        slots:
          objectType: path.objectType
          appId: path.appId
          primaryDisplayProperty: requestBody.primaryDisplayProperty
      - text: Update schema {objectType} for app {appId} with description {description}.
        slots:
          objectType: path.objectType
          appId: path.appId
          description: requestBody.description
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/schemas/{objectType}/associations/{associationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an association from a media schema
      effect: destructive
      questions:
      - Can I delete an association definition from a media object schema?
      - How do I unlink a media object type from another object type?
      instructions:
      - text: Delete association {associationId} from schema {objectType} in app {appId}.
        slots:
          associationId: path.associationId
          objectType: path.objectType
          appId: path.appId
      - text: Remove media schema association {associationId} on {objectType} for app {appId}.
        slots:
          associationId: path.associationId
          objectType: path.objectType
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update media bridge provider settings
      effect: write
      questions:
      - Can I rename my media bridge provider?
      - Is it possible to allow imports when the media connection is disconnected?
      instructions:
      - text: Rename media bridge provider for app {appId} to {name}, stamped {updatedAt}.
        slots:
          appId: path.appId
          name: requestBody.name
          updatedAt: requestBody.updatedAt
      - text: Allow import on disconnect ({allowImportOnDisconnect}) for app {appId} at {updatedAt}.
        slots:
          allowImportOnDisconnect: requestBody.allowImportOnDisconnect
          appId: path.appId
          updatedAt: requestBody.updatedAt
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/settings/event-visibility'].get
  update:
    x-apievangelist-phrasing:
      intent: Get media event visibility settings
      effect: read
      questions:
      - Where do my media bridge events show up, timeline or reporting?
      - Can I check which media events are visible in workflows?
      instructions:
      - text: Show the event visibility settings for app {appId}.
        slots:
          appId: path.appId
      - text: Check whether media events from app {appId} appear on the timeline.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/settings/event-visibility'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change media event visibility
      effect: write
      questions:
      - Can I hide a media event type from the contact timeline?
      - How do I make media events available in workflows?
      instructions:
      - text: Show {eventType} events in the timeline ({showInTimeline}) for app {appId}, updated {updatedAt}.
        slots:
          eventType: requestBody.eventType
          showInTimeline: requestBody.showInTimeline
          appId: path.appId
          updatedAt: requestBody.updatedAt
      - text: Set workflow visibility of {eventType} events to {showInWorkflows} for app {appId} at {updatedAt}.
        slots:
          eventType: requestBody.eventType
          showInWorkflows: requestBody.showInWorkflows
          appId: path.appId
          updatedAt: requestBody.updatedAt
      method: generated
      generated: '2026-09-24'
- target: $.paths['/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get object definitions for a media type
      effect: read
      questions:
      - What does the object definition for VIDEO media look like in my app?
      - Can I get the full object definition for audio or document media types?
      instructions:
      - text: Show the object definition for media type {mediaType} in app {appId}.
        slots:
          mediaType: path.mediaType
          appId: path.appId
      - text: Get the full {mediaType} object definition for app {appId}.
        slots:
          mediaType: path.mediaType
          appId: path.appId
      method: generated
      generated: '2026-09-24'


# --- truncated at 32 KB (318 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/overlays/hubspot-basic-api-phrasing-overlay.yaml

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-basic-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.