Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Leads API

5 actions 5 updates phrasing extends openapi/cvent-leads-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 5

$.info

$.paths['/eliterature-requests'].get

$.paths['/events/{id}/exhibitors/{exhibitorId}/leads/{leadId}/answers'].get

$.paths['/leads'].get

$.paths['/leads/filter'].post

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 Leads API
  version: 1.0.0
extends: openapi/cvent-leads-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: 4
- target: $.paths['/eliterature-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List e-literature requests
      effect: read
      questions:
      - Which attendees asked exhibitors for digital brochures?
      - Can I get e-literature requests made after a certain date?
      instructions:
      - text: List all e-literature requests.
      - text: List e-literature requests matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/leads/{leadId}/answers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead's qualification answers
      effect: read
      questions:
      - What did a lead answer to an exhibitor's qualification questions?
      - Can I see how a scanned lead was qualified at the booth?
      instructions:
      - text: Get qualification answers for lead {leadId} of exhibitor {exhibitorId} in event {id}.
        slots:
          leadId: path.leadId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show how lead {leadId} answered exhibitor {exhibitorId}'s questions at event {id}.
        slots:
          leadId: path.leadId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads'].get
  update:
    x-apievangelist-phrasing:
      intent: List leads
      effect: read
      questions:
      - How do I export the leads exhibitors captured at my events?
      - Can I list leads captured since a particular time?
      instructions:
      - text: List all leads.
      - text: List leads captured after {after}.
        slots:
          after: query.after
      - text: List leads matching the query filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search leads with a body filter
      effect: read
      questions:
      - My leads filter is too long for the URL — can I send it in the body?
      - Can I search exhibitor leads with a complex posted filter?
      instructions:
      - text: Search leads using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find leads matching posted filter {filter} before {before}.
        slots:
          filter: requestBody.filter
          before: query.before
      method: generated
      generated: '2026-09-26'