Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Leads API

5 actions 5 updates phrasing extends openapi/cvent-registration-leads-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration 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-registration-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 requested exhibitor e-literature at my events?
      - Can I pull e-literature requests within a date range?
      instructions:
      - text: List e-literature requests.
      - text: List e-literature requests created after {after} matching {filter}.
        slots:
          after: query.after
          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:
      - How did a captured lead answer the exhibitor's qualification questions?
      - Where can I see the qualification answers for one lead?
      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 exhibitor leads
      effect: read
      questions:
      - What leads have exhibitors captured at my events?
      - Can I list leads collected since a certain date?
      instructions:
      - text: List leads matching query filter {filter}.
        slots:
          filter: query.filter
      - text: List leads captured after {after}.
        slots:
          after: query.after
      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:
      - Can I search leads by sending a long filter in the request body?
      - Is there a POST version of the leads list for complex filters?
      instructions:
      - text: Search leads with body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search leads captured before {before} using body filter {filter}.
        slots:
          before: query.before
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'