HubSpot Engagement Emails API — Emails

naftiko: 1.0.0-alpha2
info:
  label: HubSpot Engagement Emails API — Emails
  description: 'HubSpot Engagement Emails API — Emails. 6 operations. Lead operation: Hubspot List Email Engagements. Self-contained
    Naftiko capability covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Emails
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: engagement-emails-emails
    baseUri: https://api.hubapi.com
    description: HubSpot Engagement Emails API — Emails business capability. Self-contained, no shared references.
    resources:
    - name: crm-v3-objects-emails
      path: /crm/v3/objects/emails
      operations:
      - name: listemailengagements
        method: GET
        description: Hubspot List Email Engagements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to return per page.
        - name: after
          in: query
          type: string
          description: The cursor for pagination to get the next page of results.
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived email engagements.
      - name: createemailengagement
        method: POST
        description: Hubspot Create an Email Engagement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-emails-search
      path: /crm/v3/objects/emails/search
      operations:
      - name: searchemailengagements
        method: POST
        description: Hubspot Search Email Engagements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-emails-emailId
      path: /crm/v3/objects/emails/{emailId}
      operations:
      - name: getemailengagement
        method: GET
        description: Hubspot Get an Email Engagement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailId
          in: path
          type: string
          description: The ID of the email engagement to retrieve.
          required: true
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived email engagements.
      - name: updateemailengagement
        method: PATCH
        description: Hubspot Update an Email Engagement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailId
          in: path
          type: string
          description: The ID of the email engagement to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteemailengagement
        method: DELETE
        description: Hubspot Archive an Email Engagement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailId
          in: path
          type: string
          description: The ID of the email engagement to archive.
          required: true
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: engagement-emails-emails-rest
    port: 8080
    description: REST adapter for HubSpot Engagement Emails API — Emails. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/crm/v3/objects/emails
      name: crm-v3-objects-emails
      description: REST surface for crm-v3-objects-emails.
      operations:
      - method: GET
        name: listemailengagements
        description: Hubspot List Email Engagements
        call: engagement-emails-emails.listemailengagements
        with:
          limit: rest.limit
          after: rest.after
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createemailengagement
        description: Hubspot Create an Email Engagement
        call: engagement-emails-emails.createemailengagement
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/emails/search
      name: crm-v3-objects-emails-search
      description: REST surface for crm-v3-objects-emails-search.
      operations:
      - method: POST
        name: searchemailengagements
        description: Hubspot Search Email Engagements
        call: engagement-emails-emails.searchemailengagements
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/emails/{emailid}
      name: crm-v3-objects-emails-emailid
      description: REST surface for crm-v3-objects-emails-emailId.
      operations:
      - method: GET
        name: getemailengagement
        description: Hubspot Get an Email Engagement
        call: engagement-emails-emails.getemailengagement
        with:
          emailId: rest.emailId
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateemailengagement
        description: Hubspot Update an Email Engagement
        call: engagement-emails-emails.updateemailengagement
        with:
          emailId: rest.emailId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteemailengagement
        description: Hubspot Archive an Email Engagement
        call: engagement-emails-emails.deleteemailengagement
        with:
          emailId: rest.emailId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: engagement-emails-emails-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot Engagement Emails API — Emails. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: hubspot-list-email-engagements
      description: Hubspot List Email Engagements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: engagement-emails-emails.listemailengagements
      with:
        limit: tools.limit
        after: tools.after
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-create-email-engagement
      description: Hubspot Create an Email Engagement
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: engagement-emails-emails.createemailengagement
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-search-email-engagements
      description: Hubspot Search Email Engagements
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: engagement-emails-emails.searchemailengagements
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-get-email-engagement
      description: Hubspot Get an Email Engagement
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: engagement-emails-emails.getemailengagement
      with:
        emailId: tools.emailId
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-update-email-engagement
      description: Hubspot Update an Email Engagement
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: engagement-emails-emails.updateemailengagement
      with:
        emailId: tools.emailId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-archive-email-engagement
      description: Hubspot Archive an Email Engagement
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: engagement-emails-emails.deleteemailengagement
      with:
        emailId: tools.emailId
      outputParameters:
      - type: object
        mapping: $.