# 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 Surveys API
  version: 1.0.0
extends: openapi/cvent-surveys-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: 23
- target: $.paths['/events/surveys/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List survey responses across all events
      effect: read
      questions:
      - How can I pull every event survey response across all my events at once?
      - Can I get event survey answers submitted after a certain date?
      instructions:
      - text: List event survey responses from all events submitted after {after}.
        slots:
          after: query.after
      - text: Pull all event survey responses matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List surveys attached to an event
      effect: read
      questions:
      - Which surveys are attached to my event?
      - What feedback surveys does a particular event run?
      instructions:
      - text: List surveys for event {id}.
        slots:
          id: path.id
      - text: Show event {id} surveys matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the questions in an event survey
      effect: read
      questions:
      - What questions does an event's feedback survey ask?
      - Can I see the question list for one survey on an event?
      instructions:
      - text: List the questions in survey {surveyId} of event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Show up to {limit} questions from event {id} survey {surveyId}.
        slots:
          limit: query.limit
          id: path.id
          surveyId: path.surveyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/respondents'].get
  update:
    x-apievangelist-phrasing:
      intent: List respondents to an event survey
      effect: read
      questions:
      - Who has responded to a survey on my event?
      - Can I filter the respondents of an event survey?
      instructions:
      - text: List respondents to survey {surveyId} on event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Show event {id} survey {surveyId} respondents matching {filter}.
        slots:
          id: path.id
          surveyId: path.surveyId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/respondents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a respondent to an event survey
      effect: write
      questions:
      - How do I register someone as a respondent on an event survey?
      - Can I create an event survey respondent for an existing attendee?
      instructions:
      - text: Add attendee {attendee} as a respondent to survey {surveyId} on event {id}.
        slots:
          attendee: requestBody.attendee
          surveyId: path.surveyId
          id: path.id
      - text: Create a respondent on event {id} survey {surveyId} for contact {contact}.
        slots:
          id: path.id
          surveyId: path.surveyId
          contact: requestBody.contact
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/respondents/{respondentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event survey respondent
      effect: write
      questions:
      - How do I change details on an existing event survey respondent?
      - Can I update a respondent's score on an event survey?
      instructions:
      - text: Update respondent {respondentId} on event {id} survey {surveyId}.
        slots:
          respondentId: path.respondentId
          id: path.id
          surveyId: path.surveyId
      - text: Set the score of event survey respondent {respondentId} (survey {surveyId}, event {id}) to {score}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          id: path.id
          score: requestBody.score
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/respondents/{respondentId}/responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit answers for an event survey respondent
      effect: write
      questions:
      - How do I record a respondent's answers to an event survey?
      - Can I submit event survey answers tied to a specific session or speaker?
      instructions:
      - text: Submit answers {answers} to question {question} for respondent {respondentId} on event {id} survey {surveyId}.
        slots:
          answers: requestBody.answers
          question: requestBody.question
          respondentId: path.respondentId
          id: path.id
          surveyId: path.surveyId
      - text: Record event {id} survey {surveyId} answers from respondent {respondentId} about session {session}.
        slots:
          id: path.id
          surveyId: path.surveyId
          respondentId: path.respondentId
          session: requestBody.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys/{surveyId}/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List responses to one event survey
      effect: read
      questions:
      - What answers came back on a specific event survey?
      - Can I read the responses to one survey on one event?
      instructions:
      - text: List responses to survey {surveyId} on event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Show event {id} survey {surveyId} responses matching {filter}.
        slots:
          id: path.id
          surveyId: path.surveyId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/large-choices'].get
  update:
    x-apievangelist-phrasing:
      intent: List choices for large-choice survey questions
      effect: read
      questions:
      - Where do I get the options for a survey question with a very large choice list?
      - Can I filter the choices of a LargeChoices question?
      instructions:
      - text: List large choices matching {filter}.
        slots:
          filter: query.filter
      - text: Show {limit} large-choice question options.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List survey questions across all surveys
      effect: read
      questions:
      - What questions exist across both event and standalone surveys?
      - Can I search survey questions account-wide?
      instructions:
      - text: List survey questions across my account matching {filter}.
        slots:
          filter: query.filter
      - text: Show all survey questions updated after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/respondents'].get
  update:
    x-apievangelist-phrasing:
      intent: List respondents across all surveys
      effect: read
      questions:
      - Who has responded to any of our surveys, event or standalone?
      - Can I list all survey respondents account-wide?
      instructions:
      - text: List survey respondents across all surveys matching {filter}.
        slots:
          filter: query.filter
      - text: Show every survey respondent added after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List responses across all surveys
      effect: read
      questions:
      - What survey answers have we collected across event and standalone surveys?
      - Can I pull all survey responses for the account before a date?
      instructions:
      - text: List survey responses account-wide matching {filter}.
        slots:
          filter: query.filter
      - text: Show every survey response recorded before {before}.
        slots:
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List standalone surveys
      effect: read
      questions:
      - Which surveys do we run that are not tied to any event?
      - Can I list our standalone surveys?
      instructions:
      - text: List standalone surveys matching {filter}.
        slots:
          filter: query.filter
      - text: Show standalone surveys created after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List responses to standalone surveys
      effect: read
      questions:
      - What answers have come in on our standalone surveys?
      - Can I filter standalone survey responses?
      instructions:
      - text: List standalone survey responses matching {filter}.
        slots:
          filter: query.filter
      - text: Show standalone survey responses submitted after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates for a standalone survey
      effect: read
      questions:
      - Which email templates can I send for a standalone survey?
      - What invitation and reminder templates does a standalone survey have?
      instructions:
      - text: List email templates for standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show up to {limit} email templates of standalone survey {surveyId}.
        slots:
          limit: query.limit
          surveyId: path.surveyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List questions in a standalone survey
      effect: read
      questions:
      - What does a standalone survey ask?
      - Can I see the question list for a survey not tied to an event?
      instructions:
      - text: List questions in standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show {limit} questions from standalone survey {surveyId}.
        slots:
          limit: query.limit
          surveyId: path.surveyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents'].get
  update:
    x-apievangelist-phrasing:
      intent: List respondents to a standalone survey
      effect: read
      questions:
      - Who has been invited to or answered a standalone survey?
      - Can I filter a standalone survey's respondents?
      instructions:
      - text: List respondents to standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show standalone survey {surveyId} respondents matching {filter}.
        slots:
          surveyId: path.surveyId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a respondent to a standalone survey
      effect: write
      questions:
      - How do I add a contact as a respondent to a standalone survey?
      - Can I add a respondent to a standalone survey from an invitation list?
      instructions:
      - text: Add contact {contact} as a respondent to standalone survey {surveyId}.
        slots:
          contact: requestBody.contact
          surveyId: path.surveyId
      - text: Create a standalone survey {surveyId} respondent from invitation list {invitationList}.
        slots:
          surveyId: path.surveyId
          invitationList: requestBody.invitationList
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents/{respondentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a standalone survey respondent
      effect: write
      questions:
      - How do I mark a standalone survey respondent as unsubscribed?
      - Can I change the status of an existing standalone survey respondent?
      instructions:
      - text: Set respondent {respondentId} on standalone survey {surveyId} to status {status}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          status: requestBody.status
      - text: 'Mark standalone survey {surveyId} respondent {respondentId} unsubscribed: {unsubscribed}.'
        slots:
          surveyId: path.surveyId
          respondentId: path.respondentId
          unsubscribed: requestBody.unsubscribed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents/{respondentId}/email-templates/{emailTemplateId}/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a standalone survey to a respondent
      effect: write
      questions:
      - How do I send a standalone survey invitation to one respondent?
      - Can I email a respondent using a specific survey template?
      instructions:
      - text: Send template {emailTemplateId} for standalone survey {surveyId} to respondent {respondentId}.
        slots:
          emailTemplateId: path.emailTemplateId
          surveyId: path.surveyId
          respondentId: path.respondentId
      - text: Email respondent {respondentId} the survey {surveyId} message {emailTemplateId}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          emailTemplateId: path.emailTemplateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents/{respondentId}/responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit answers to a standalone survey
      effect: write
      questions:
      - How do I record a respondent's answers to a standalone survey?
      - Can I load standalone survey responses collected offline?
      instructions:
      - text: Submit standalone survey {surveyId} answers for respondent {respondentId}.
        slots:
          surveyId: path.surveyId
          respondentId: path.respondentId
      - text: Record new responses from {respondentId} on standalone survey {surveyId}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents/{respondentId}/responses/{responseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a standalone survey response
      effect: write
      questions:
      - How do I correct an answer a respondent already gave on a standalone survey?
      - Can I edit an existing standalone survey response?
      instructions:
      - text: Update response {responseId} from respondent {respondentId} on standalone survey {surveyId}.
        slots:
          responseId: path.responseId
          respondentId: path.respondentId
          surveyId: path.surveyId
      - text: Correct standalone survey {surveyId} answer {responseId} for {respondentId}.
        slots:
          surveyId: path.surveyId
          responseId: path.responseId
          respondentId: path.respondentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List all surveys in the account
      effect: read
      questions:
      - What surveys, event and standalone together, exist in our Cvent account?
      - Can I get one list of every survey we have?
      instructions:
      - text: List all surveys in my account matching {filter}.
        slots:
          filter: query.filter
      - text: Show every survey, event or standalone, created after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'