Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Emails API

4 actions 4 updates phrasing extends openapi/cvent-emails-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/bounces'].get

$.paths['/emails'].get

$.paths['/emails/{emailRequestId}/status'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Emails API
  version: 1.0.0
extends: openapi/cvent-emails-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: List email bounces
      effect: read
      questions:
      - Which of my emails bounced last month?
      - How far back can I pull email bounce details?
      instructions:
      - text: List email bounces from the past month.
      - text: List email bounces after {after} and before {before}.
        slots:
          after: query.after
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent email history
      effect: read
      questions:
      - What emails has my account sent recently?
      - Can I get sent email history for up to six months?
      instructions:
      - text: List my sent email history.
      - text: List emails sent after {after} matching {filter}.
        slots:
          after: query.after
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emails/{emailRequestId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check delivery status of an email send
      effect: read
      questions:
      - How do I check whether an email send request was delivered?
      - Can I track the status of emails I sent to recipients using the request ID?
      instructions:
      - text: Get the status of email request {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      - text: Check delivery status for email send {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      method: generated
      generated: '2026-09-26'