Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor API

31 actions 31 updates phrasing extends openapi/cvent-event-cloud-exhibitor-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cvent Event Cloud's API. It is a proposal applied on top of the contract, not a document Cvent Event Cloud 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-event-cloud-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 on 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} on event {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add a new {type} exhibitor category {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 on my event?
      - What do I send to change the description of an existing exhibitor category?
      instructions:
      - text: Rename exhibitor category {exhibitorCategoryId} on event {id} to {name}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          name: requestBody.name
      - text: Move existing exhibitor category {exhibitorCategoryId} in event {id} to display order {order}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          order: requestBody.order
      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 an exhibitor category be deleted once it's no longer needed?
      instructions:
      - text: Delete exhibitor category {exhibitorCategoryId} from event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Remove the whole exhibitor category {exhibitorCategoryId} on 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?
      - Will assigning a new category banner replace the one already there?
      instructions:
      - text: Set uploaded file {fileId} as the banner for exhibitor category {exhibitorCategoryId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Replace the category banner of exhibitor category {exhibitorCategoryId} in event {id} with file {fileId}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          fileId: path.fileId
      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 without deleting the category?
      - What happens when I delete a category's banner file?
      instructions:
      - text: Delete banner file {fileId} from exhibitor category {exhibitorCategoryId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Clear the category banner image {fileId} for exhibitor category {exhibitorCategoryId} in 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?
      - How can I see every booth in one category of my event?
      instructions:
      - text: List the exhibitors in category {exhibitorCategoryId} for event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Show up to {limit} exhibitors assigned to exhibitor category {exhibitorCategoryId} on 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:
      - Can I put an exhibitor into an exhibitor category?
      - What's needed to tag an existing exhibitor with a category?
      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} into exhibitor category {exhibitorCategoryId} on 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:
      - How do I take an exhibitor out of a category without deleting the exhibitor?
      - Can one exhibitor be unassigned from a single 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} on event {id}.
        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 are exhibitors asked to answer for my event?
      - Which exhibitor profile questions are configured on an event?
      instructions:
      - text: List the exhibitor questions set up for event {id}.
        slots:
          id: path.id
      - text: Show me the questionnaire exhibitors fill in 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 an event's exhibitors
      effect: read
      questions:
      - Which exhibitors are signed up for my Cvent event?
      - Can I filter the event's exhibitor list to ones changed after a certain date?
      - How do I page through every exhibitor at a trade show?
      instructions:
      - text: List all exhibitors for event {id}.
        slots:
          id: path.id
      - text: List exhibitors on event {id} modified after {after}.
        slots:
          id: path.id
          after: query.after
      - text: Find exhibitors at 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: Create an exhibitor for an event
      effect: write
      questions:
      - How do I add a new exhibitor company to an event?
      - Can I mark an exhibitor as a sponsor or featured when I create it?
      instructions:
      - text: Register a new exhibiting company {name} for 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 booth location and contact info?
      instructions:
      - text: Get exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the full profile of exhibitor {exhibitorId} for 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 booth location?
      - Can I hide an exhibitor that's already been created?
      instructions:
      - text: Update exhibitor {exhibitorId} on event {id} to booth location {location}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          location: requestBody.location
      - text: Change the contact email of existing exhibitor {exhibitorId} in event {id} to {email}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor
      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} 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 set the banner image on an exhibitor's profile?
      - Does assigning an exhibitor banner overwrite the existing banner?
      instructions:
      - text: Set file {fileId} as the banner for exhibitor {exhibitorId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Replace exhibitor {exhibitorId}'s banner at event {id} with uploaded file {fileId}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          fileId: path.fileId
      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 delete the banner image from an exhibitor profile?
      - What removes an exhibitor's banner without touching their logo?
      instructions:
      - text: Delete banner {fileId} from exhibitor {exhibitorId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Clear the banner image {fileId} on exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          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 question answers
      effect: read
      questions:
      - How did a particular exhibitor answer the exhibitor questions?
      - Where can I read one exhibitor's questionnaire responses?
      instructions:
      - text: List exhibitor {exhibitorId}'s answers to the exhibitor questions on event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the questionnaire responses from exhibitor {exhibitorId} at 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?
      - Is it possible to skip questions marked required for exhibitor admins when updating answers?
      instructions:
      - text: Update the exhibitor question answers for exhibitor {exhibitorId} on event {id} with {data}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          data: requestBody.data
      - text: Save these questionnaire answers {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 specific exhibitor assigned to?
      - Can I check what exhibitor categories one company falls under?
      instructions:
      - text: List the categories exhibitor {exhibitorId} belongs to at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show which exhibitor categories are assigned to exhibitor {exhibitorId} on 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 upload and attach a company logo to an exhibitor?
      - Will setting a new exhibitor logo replace the old one?
      instructions:
      - text: Set file {fileId} as the logo for exhibitor {exhibitorId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Replace exhibitor {exhibitorId}'s logo at event {id} with file {fileId}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          fileId: path.fileId
      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 the logo from an exhibitor profile?
      - What removes an exhibitor's logo but keeps the banner?
      instructions:
      - text: Delete logo {fileId} from exhibitor {exhibitorId} on event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Clear the logo image {fileId} on exhibitor {exhibitorId} in 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?
      - Which questions will a booth use to qualify leads at my event?
      instructions:
      - text: List the lead qualification questions for exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the lead-scoring questions exhibitor {exhibitorId} uses on 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:
      - Does this exhibitor already have a registration pack for the event?
      - Where can I see an exhibitor's consolidated registration capacities?
      instructions:
      - text: Show the registration pack assigned to exhibitor {exhibitorId} on event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Look up whether exhibitor {exhibitorId} at event {id} has a registration pack.
        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 an allocation of registrations for their staff?
      - Can I set per-registration-type capacities when creating an exhibitor pack?
      instructions:
      - text: Create a registration pack for exhibitor {exhibitorId} on event {id} with capacities {capacities}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          capacities: requestBody.capacities
      - text: Allocate registration capacities {capacities} to exhibitor {exhibitorId} in event {id} as a new pack.
        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 a registration pack and its usage
      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} on event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show used versus allocated registrations in pack {registrationPackId} of 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: Update an exhibitor's registration pack
      effect: write
      questions:
      - Can I raise an exhibitor's registration allowance after the pack is created?
      - How do I change capacities in an existing registration pack?
      instructions:
      - text: Update registration pack {registrationPackId} for exhibitor {exhibitorId} on 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 a registration pack from an exhibitor?
      - What deletes an exhibitor's registration allocation altogether?
      instructions:
      - text: Delete registration pack {registrationPackId} for exhibitor {exhibitorId} on event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove 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 are defined for my event?
      - Which sponsorship levels can exhibitors be placed in?
      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
      effect: read
      questions:
      - What are the details of a specific sponsorship level?
      - Can I look up a single sponsor tier by its ID?
      instructions:
      - text: Get sponsorship level {sponsorshipLevelId} for event {id}.
        slots:
          sponsorshipLevelId: path.sponsorshipLevelId
          id: path.id
      - text: Show details of sponsor tier {sponsorshipLevelId} on event {id}.
        slots:
          sponsorshipLevelId: path.sponsorshipLevelId
          id: path.id
      method: generated
      generated: '2026-09-26'