API Evangelist conversational phrasing for Cvent REST Exhibitor API

# 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-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 event?
      - Can I page through the exhibitor categories defined for a Cvent 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 my event?
      - Can I set the display order when creating an exhibitor category?
      instructions:
      - text: Create an exhibitor category called {name} on event {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add a new {type} exhibitor category named {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} on event {id} to {name}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
          name: requestBody.name
      - text: Update the description of 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 I no longer need?
      - Can I delete a whole exhibitor category from an event?
      instructions:
      - text: Delete exhibitor category {exhibitorCategoryId} from event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Remove the exhibitor category {exhibitorCategoryId} entirely 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: Set the banner image on an exhibitor category
      effect: write
      questions:
      - Can I put a banner image on an exhibitor category using a file I uploaded?
      - Will assigning a new category banner replace the one already there?
      instructions:
      - text: Use 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 on 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:
      - How do I take the banner image off an exhibitor category?
      - Can I clear a category's banner without deleting the category itself?
      instructions:
      - text: Delete banner file {fileId} from exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Remove the category banner image {fileId} from exhibitor category {exhibitorCategoryId} on 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 an exhibitor category
      effect: read
      questions:
      - Which exhibitors are assigned to a particular exhibitor category?
      - Who is in the Gold Booths category at my event?
      instructions:
      - text: List the exhibitors assigned to exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Show me every exhibitor in category {exhibitorCategoryId} for event {id}.
        slots:
          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 assigned to a category after it's been created?
      instructions:
      - text: Assign exhibitor {exhibitorId} to exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Add exhibitor {exhibitorId} to the {exhibitorCategoryId} 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:
      - How can I take an exhibitor out of a category without deleting the exhibitor?
      - Can I unassign an exhibitor from an exhibitor category?
      instructions:
      - text: Remove exhibitor {exhibitorId} from exhibitor category {exhibitorCategoryId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          exhibitorCategoryId: path.exhibitorCategoryId
          id: path.id
      - text: Unassign exhibitor {exhibitorId} from 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 the exhibitor questions for an event
      effect: read
      questions:
      - What questions are exhibitors asked to answer for my event?
      - Where can I see the exhibitor question set configured on an event?
      instructions:
      - text: List the exhibitor questions configured 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:
      - Which exhibitors are signed up for my event?
      - Can I list only exhibitors changed after a certain date?
      - How do I filter the exhibitor list for a Cvent event?
      instructions:
      - text: List all exhibitors for event {id}.
        slots:
          id: path.id
      - text: Show exhibitors for 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:
      - What do I need to register a new company as an exhibitor at my event?
      - Can I set the booth location and website when creating an exhibitor?
      instructions:
      - text: Create an exhibitor named {name} for event {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add exhibitor {name} to event {id} at booth {location} with website {website}.
        slots:
          name: requestBody.name
          id: path.id
          location: requestBody.location
          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 contact details do we have on file for a specific exhibitor?
      - Can I look up a single exhibitor by its ID?
      instructions:
      - text: Get exhibitor {exhibitorId} from event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the full profile of exhibitor {exhibitorId} at 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 existing exhibitor
      effect: write
      questions:
      - Can I change an exhibitor's email or phone number after they're added?
      - Is there a way to mark an existing exhibitor as featured or hidden?
      instructions:
      - text: Update the email of exhibitor {exhibitorId} in event {id} to {email}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          email: requestBody.email
      - text: Set sponsorship level {sponsorshipLevel} on existing exhibitor {exhibitorId} for event {id}.
        slots:
          sponsorshipLevel: requestBody.sponsorshipLevel
          exhibitorId: path.exhibitorId
          id: path.id
      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 still 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: Remove the exhibitor record {exhibitorId} permanently 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: Set an exhibitor's banner image
      effect: write
      questions:
      - How do I give an exhibitor a banner image from an uploaded file?
      - Does setting an exhibitor banner overwrite the existing 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 banner image with uploaded file {fileId} on 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 from an exhibitor's profile?
      - What's the way to clear an exhibitor banner image?
      instructions:
      - text: Delete banner {fileId} from exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Take the banner image {fileId} off 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}/exhibitor-answers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exhibitor's answers to exhibitor questions
      effect: read
      questions:
      - How did a particular exhibitor answer the exhibitor questionnaire?
      - Can I see the responses an exhibitor gave to our event's questions?
      instructions:
      - text: List the answers exhibitor {exhibitorId} gave to exhibitor questions in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show 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 questionnaire answers
      effect: write
      questions:
      - Can a planner fill in exhibitor question answers on the exhibitor's behalf?
      - Do I have to answer required exhibitor questions when updating answers as a planner?
      instructions:
      - text: Update exhibitor {exhibitorId}'s answers in event {id} with {data}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          data: requestBody.data
      - text: Save these exhibitor question 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 has a given exhibitor been placed in?
      - Can I check what exhibitor categories one exhibitor is assigned to?
      instructions:
      - text: List the categories exhibitor {exhibitorId} belongs to in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show which exhibitor categories exhibitor {exhibitorId} is assigned to at 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: Set an exhibitor's logo image
      effect: write
      questions:
      - How do I attach a logo to an exhibitor?
      - Will a new exhibitor logo replace the current one?
      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: Swap exhibitor {exhibitorId}'s logo for uploaded file {fileId} on 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 the logo from an exhibitor profile?
      - What happens to an exhibitor's logo if I remove it?
      instructions:
      - text: Delete logo {fileId} from exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove the logo image {fileId} from exhibitor {exhibitorId} at 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 attendees?
      - Can I pull the lead-capture qualifying questions for one exhibitor?
      instructions:
      - text: List the lead qualification questions for exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the lead capture qualifying questions exhibitor {exhibitorId} uses in 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: List an exhibitor's registration packs
      effect: read
      questions:
      - Does this exhibitor have a registration pack for the event?
      - Where can I see the registration capacities allotted to an exhibitor?
      instructions:
      - text: List the registration packs for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Find the registration pack assigned to exhibitor {exhibitorId} 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 set number of registrations for their staff?
      - Can I allocate registration capacities to an exhibitor by registration type?
      instructions:
      - text: Create a registration pack for exhibitor {exhibitorId} at event {id} with capacities {capacities}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
          capacities: requestBody.capacities
      - text: Allocate registration capacities {capacities} to exhibitor {exhibitorId} for 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 included in a specific 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} at 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 increase the registration capacity in an exhibitor's existing pack?
      - Is it possible to change allocations on a registration pack after it's 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 on existing pack {registrationPackId} of 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}/exhibitors/{exhibitorId}/registration-packs/{registrationPackId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor's registration pack
      effect: destructive
      questions:
      - How do I remove a registration pack from an exhibitor?
      - Can I revoke an exhibitor's allotted registrations entirely?
      instructions:
      - text: Delete registration pack {registrationPackId} from exhibitor {exhibitorId} in event {id}.
        slots:
          registrationPackId: path.registrationPackId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove exhibitor {exhibitorId}'s registration pack {registrationPackId} for event {id}.
        slots:
          exhibitorId: path.exhibitorId
          registrationPackId: path.registrationPackId
          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 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
      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} at event {id}.
        slots:
          sponsorshipLevelId: path.sponsorshipLevelId
          id: path.id
      method: generated
      generated: '2026-09-26'