Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Emails API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v2/emails'].get
$.paths['/v2/emails/{id}'].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 Qualified Enterprise Emails API
  version: 1.0.0
extends: openapi/qualified-com-emails-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v2/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List outbound email activity
      effect: read
      questions:
      - How do I see which outbound emails were opened, clicked or bounced recently?
      - Can I list only the emails sent to one particular lead?
      - What delay is there before a sent email shows up in the email activity list?
      instructions:
      - text: List emails with engagement updated since {updated_after}.
        slots:
          updated_after: query.updated_after
      - text: Show all emails sent to lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: List new email sends created between {created_after} and {created_before}.
        slots:
          created_after: query.created_after
          created_before: query.created_before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/emails/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email activity by id
      effect: read
      questions:
      - Can I check the status of a single sent email by its id?
      - Where do I find the details of one specific outbound email?
      instructions:
      - text: Get email activity {id}.
        slots:
          id: path.id
      - text: Show whether email {id} was opened, clicked or bounced.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'