Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Campaigns API

5 actions 5 updates phrasing extends openapi/cvent-registration-campaigns-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['/campaigns'].get

$.paths['/emarketing/campaigns/{campaignId}/email-templates'].get

$.paths['/emarketing/emails'].post

$.paths['/emarketing/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 Campaigns API
  version: 1.0.0
extends: openapi/cvent-registration-campaigns-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['/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List eMarketing campaigns
      effect: read
      questions:
      - What eMarketing campaigns do we have running in Cvent?
      - Can I filter marketing campaigns by date or name?
      instructions:
      - text: List eMarketing campaigns.
      - text: Show eMarketing campaigns matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emarketing/campaigns/{campaignId}/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's email templates
      effect: read
      questions:
      - Which email templates belong to a marketing campaign?
      - Where do I find the template ID to send a campaign email?
      instructions:
      - text: List email templates for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Show campaign {campaignId} email templates matching {filter}.
        slots:
          campaignId: path.campaignId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emarketing/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a campaign email to recipients
      effect: write
      questions:
      - How do I send an eMarketing email to people on a campaign's recipient list?
      - Can recipients who aren't on the campaign list receive the email?
      instructions:
      - text: Send template {templateId} to recipients {recipients}.
        slots:
          templateId: requestBody.templateId
          recipients: requestBody.recipients
      - text: Email campaign recipients {recipients} using eMarketing template {templateId}.
        slots:
          recipients: requestBody.recipients
          templateId: requestBody.templateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emarketing/emails/{emailRequestId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a campaign email send
      effect: read
      questions:
      - Did my eMarketing email send go through?
      - What's the delivery status of a campaign email request?
      instructions:
      - text: Check the status of email request {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      - text: Show whether campaign send {emailRequestId} has been delivered.
        slots:
          emailRequestId: path.emailRequestId
      method: generated
      generated: '2026-09-26'