Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor API

31 actions 31 updates phrasing extends openapi/cvent-registration-exhibitor-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 31 · first 16 shown; the file carries all of them

$.info
$.paths['/events/{id}/exhibitor-categories'].get
$.paths['/events/{id}/exhibitor-categories'].post
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}'].put
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}'].delete
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/banner-files/{fileId}'].put
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/banner-files/{fileId}'].delete
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors'].get
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors/{exhibitorId}'].put
$.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors/{exhibitorId}'].delete
$.paths['/events/{id}/exhibitor-questions'].get
$.paths['/events/{id}/exhibitors'].get
$.paths['/events/{id}/exhibitors'].post
$.paths['/events/{id}/exhibitors/{exhibitorId}'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}'].put
$.paths['/events/{id}/exhibitors/{exhibitorId}'].delete

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 Cvent REST Exhibitor API
  version: 1.0.0
extends: openapi/cvent-registration-exhibitor-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: 30
- target: $.paths['/events/{id}/exhibitor-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's exhibitor categories
      effect: read
      questions:
      - What exhibitor categories are set up for my Cvent event?
      - Can I page through all the exhibitor categories defined for one event?
      instructions:
      - text: List the exhibitor categories for event {id}.
        slots:
          id: path.id
      - text: Show the first {limit} exhibitor categories configured for event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an exhibitor category for an event
      effect: write
      questions:
      - How do I add a new exhibitor category to an event?
      - Can I set the display order when creating an exhibitor category?
      instructions:
      - text: Create an exhibitor category named {name} for event {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add a new {type} exhibitor category called {name} to event {id} at position {order}.
        slots:
          type: requestBody.type
          name: requestBody.name
          id: path.id
          order: requestBody.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing exhibitor category
      effect: write
      questions:
      - Can I rename an exhibitor category that already exists?
      - Is it possible to change the order or description of an existing exhibitor category?
      instructions:
      - text: Rename exhibitor category {exhibitorCategoryId} in event {id} to {name}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          name: requestBody.name
      - text: Change the description of existing exhibitor category {exhibitorCategoryId} in event {id} to {description}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor category
      effect: destructive
      questions:
      - How do I remove an exhibitor category from an event entirely?
      - Can I delete an exhibitor category I no longer use?
      instructions:
      - text: Delete exhibitor category {exhibitorCategoryId} from event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Remove the whole exhibitor category {exhibitorCategoryId} from event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/banner-files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a banner image to an exhibitor category
      effect: write
      questions:
      - How do I put a banner image on an exhibitor category?
      - Does assigning a new category banner replace the one already there?
      instructions:
      - text: Set uploaded file {fileId} as the banner for exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Replace the category banner of exhibitor category {exhibitorCategoryId} with file {fileId} for event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/banner-files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the banner from an exhibitor category
      effect: destructive
      questions:
      - Can I take the banner image off an exhibitor category?
      - What happens if I delete an exhibitor category's banner file?
      instructions:
      - text: Delete banner {fileId} from exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Clear the category banner image {fileId} on exhibitor category {exhibitorCategoryId} for event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List the exhibitors in a category
      effect: read
      questions:
      - Which exhibitors are assigned to a particular exhibitor category?
      - Can I see every exhibitor that belongs to one category at an event?
      instructions:
      - text: List the exhibitors assigned to category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Show up to {limit} exhibitors in exhibitor category {exhibitorCategoryId} for event {id}.
        slots:
          limit: query.limit
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors/{exhibitorId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign an exhibitor to a category
      effect: write
      questions:
      - How do I put an exhibitor into an exhibitor category?
      - Can one exhibitor be added to an additional category at the same event?
      instructions:
      - text: Assign exhibitor {exhibitorId} to category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Add exhibitor {exhibitorId} to the {exhibitorCategoryId} exhibitor category for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-categories/{exhibitorCategoryId}/exhibitors/{exhibitorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an exhibitor from a category
      effect: destructive
      questions:
      - Can I take an exhibitor out of a category without deleting the exhibitor?
      - How do I unassign an exhibitor from an exhibitor category?
      instructions:
      - text: Remove exhibitor {exhibitorId} from category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Unassign exhibitor {exhibitorId} from exhibitor category {exhibitorCategoryId} for event {id}, keeping the exhibitor.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitor-questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's exhibitor questions
      effect: read
      questions:
      - What questions do exhibitors have to answer for this event?
      - Which exhibitor profile questions are configured on an event?
      instructions:
      - text: List the exhibitor questions for event {id}.
        slots:
          id: path.id
      - text: Show me the questionnaire exhibitors fill out for event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List exhibitors at an event
      effect: read
      questions:
      - Who is exhibiting at my event?
      - Can I filter an event's exhibitor list or limit it to recently changed ones?
      instructions:
      - text: List all exhibitors for event {id}.
        slots:
          id: path.id
      - text: Show exhibitors in event {id} modified after {after}.
        slots:
          id: path.id
          after: query.after
      - text: Find exhibitors in event {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new exhibitor to an event
      effect: write
      questions:
      - How do I create an exhibitor record for a trade show booth?
      - Can I mark a new exhibitor as featured or as an event sponsor when adding it?
      instructions:
      - text: Register a new exhibiting company called {name} at event {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add exhibitor {name} to event {id} with contact email {email} and website {website}.
        slots:
          name: requestBody.name
          id: path.id
          email: requestBody.email
          website: requestBody.website
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one exhibitor's details
      effect: read
      questions:
      - What details are stored for a specific exhibitor at my event?
      - Can I look up a single exhibitor's contact info and sponsorship level?
      instructions:
      - text: Get exhibitor {exhibitorId} from event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the full profile of exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exhibitor's details
      effect: write
      questions:
      - How do I change an existing exhibitor's name or contact details?
      - Can I hide an exhibitor or change its sponsorship level after it was created?
      instructions:
      - text: Update exhibitor {exhibitorId} in event {id} to use email {email}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          email: requestBody.email
      - text: Set the sponsorship level of existing exhibitor {exhibitorId} in event {id} to {sponsorshipLevel}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          sponsorshipLevel: requestBody.sponsorshipLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor from an event
      effect: destructive
      questions:
      - Why can't I delete an exhibitor that has registrations or lead capture licenses?
      - Can a sponsored or featured exhibitor be deleted?
      instructions:
      - text: Delete exhibitor {exhibitorId} from event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Permanently remove exhibitor {exhibitorId} and its record from event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/banner-files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a banner image to an exhibitor
      effect: write
      questions:
      - How do I add a banner image to an exhibitor's profile?
      - Will a new exhibitor banner overwrite the current one?
      instructions:
      - text: Set file {fileId} as the banner for exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Replace exhibitor {exhibitorId}'s profile banner with uploaded file {fileId} for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/banner-files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an exhibitor's banner image
      effect: destructive
      questions:
      - Can I remove the banner image from an exhibitor profile?
      - What if an exhibitor's banner is wrong and I want it gone?
      instructions:
      - text: Take the banner image {fileId} off exhibitor {exhibitorId}'s own profile at event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Clear exhibitor {exhibitorId}'s profile banner image {fileId} for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/exhibitor-answers'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's answers to questions
      effect: read
      questions:
      - How did a given exhibitor answer the exhibitor questions?
      - Where can I see the questionnaire responses for one exhibitor?
      instructions:
      - text: Show the question answers submitted by exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: List exhibitor {exhibitorId}'s questionnaire responses for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/exhibitor-answers'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exhibitor's question answers
      effect: write
      questions:
      - Can a planner fill in exhibitor question answers on an exhibitor's behalf?
      - Do I have to answer required exhibitor questions when updating answers as the planner?
      instructions:
      - text: Update exhibitor {exhibitorId}'s question answers in event {id} with {data}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          data: requestBody.data
      - text: Save new questionnaire responses {data} for exhibitor {exhibitorId} at event {id}.
        slots:
          data: requestBody.data
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/exhibitor-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List the categories an exhibitor belongs to
      effect: read
      questions:
      - Which categories is a particular exhibitor assigned to?
      - Can I check what exhibitor categories one exhibitor is in?
      instructions:
      - text: List the categories exhibitor {exhibitorId} belongs to in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show which exhibitor categories include exhibitor {exhibitorId} for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/logo-files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a logo image to an exhibitor
      effect: write
      questions:
      - How do I set an exhibitor's company logo?
      - Does uploading a new exhibitor logo replace the old logo?
      instructions:
      - text: Set file {fileId} as the logo for exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Replace exhibitor {exhibitorId}'s logo with uploaded file {fileId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/logo-files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an exhibitor's logo image
      effect: destructive
      questions:
      - Can I delete an exhibitor's logo?
      - What's the way to clear a wrong logo off an exhibitor listing?
      instructions:
      - text: Delete logo {fileId} from exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove the company logo image {fileId} from exhibitor {exhibitorId} for event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's lead qualification questions
      effect: read
      questions:
      - What lead qualification questions does an exhibitor ask when scanning leads?
      - Can I see the questions an exhibitor uses to qualify booth leads?
      instructions:
      - text: List the lead qualification questions for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the questions exhibitor {exhibitorId} uses to qualify leads at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/registration-packs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exhibitor's registration pack
      effect: read
      questions:
      - How many registrations has an exhibitor been allotted across registration types?
      - Does an exhibitor already have a registration pack for this event?
      instructions:
      - text: Show the registration pack for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Find exhibitor {exhibitorId}'s registration pack and its capacities at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/registration-packs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a registration pack for an exhibitor
      effect: write
      questions:
      - How do I give an exhibitor a block of registrations for its staff?
      - Can I set capacities per registration type when setting up an exhibitor's pack?
      instructions:
      - text: Create a registration pack for exhibitor {exhibitorId} in event {id} with capacities {capacities}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          capacities: requestBody.capacities
      - text: Allocate new registration capacities {capacities} to exhibitor {exhibitorId} at event {id}.
        slots:
          capacities: requestBody.capacities
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/registration-packs/{registrationPackId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage for a specific registration pack
      effect: read
      questions:
      - How many of an exhibitor's allocated registrations have been used?
      - Which registration types are in a specific exhibitor registration pack?
      instructions:
      - text: Get registration pack {registrationPackId} for exhibitor {exhibitorId} in event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show used versus allocated registrations in pack {registrationPackId} for exhibitor {exhibitorId}, event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/registration-packs/{registrationPackId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an exhibitor's registration pack
      effect: write
      questions:
      - Can I raise or lower the registration capacity in an existing exhibitor pack?
      - Is it possible to adjust an exhibitor's allotment after the pack was created?
      instructions:
      - text: Update registration pack {registrationPackId} for exhibitor {exhibitorId} in event {id} to capacities {capacities}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
          capacities: requestBody.capacities
      - text: Change the capacities in existing pack {registrationPackId} of exhibitor {exhibitorId} at event {id} to {capacities}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
          capacities: requestBody.capacities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/registration-packs/{registrationPackId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor's registration pack
      effect: destructive
      questions:
      - Can I remove an exhibitor's registration allotment altogether?
      - How do I delete a registration pack I set up by mistake?
      instructions:
      - text: Delete registration pack {registrationPackId} for exhibitor {exhibitorId} in event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove the registration allotment pack {registrationPackId} from exhibitor {exhibitorId} at event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/sponsorship-levels'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's sponsorship levels
      effect: read
      questions:
      - What sponsorship tiers exist for my event?
      - Which sponsorship levels can I assign exhibitors to?
      instructions:
      - text: List the sponsorship levels for event {id}.
        slots:
          id: path.id
      - text: Show all sponsor tiers configured on event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/sponsorship-levels/{sponsorshipLevelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sponsorship level's details
      effect: read
      questions:
      - What are the details of a specific sponsorship tier?
      - Can I look up a single sponsorship level by its ID?
      instructions:
      - text: Get sponsorship level {sponsorshipLevelId} for event {id}.
        slots:
          sponsorshipLevelId: path.sponsorshipLevelId
          id: path.id
      - text: Show the details of sponsor tier {sponsorshipLevelId} at event {id}.
        slots:
          sponsorshipLevelId: path.sponsorshipLevelId
          id: path.id
      method: generated
      generated: '2026-09-26'