# 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-event-cloud-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 do I pull every event survey response across all my events at once?
      - Can I get event survey responses submitted after a certain date for all events?
      instructions:
      - text: List event survey responses across all events and surveys.
      - text: List all-event survey responses submitted after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List the surveys attached to an event
      effect: read
      questions:
      - Which surveys are attached to my event?
      - Can I see an event's feedback surveys and their chapters?
      instructions:
      - text: List surveys for event {id}.
        slots:
          id: path.id
      - text: List event {id}'s 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 questions in an event survey
      effect: read
      questions:
      - What questions does a particular event survey ask?
      - Can I read the question list of one survey on one event?
      instructions:
      - text: List questions in survey {surveyId} for event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Show the event survey questions for survey {surveyId} on event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      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 specific survey at my event?
      - Can I filter the respondents of one event survey?
      instructions:
      - text: List respondents to survey {surveyId} at event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: List 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 add an attendee as a respondent to an event survey?
      - Can I register a survey respondent for an event from an outside system?
      instructions:
      - text: Create a respondent for attendee {attendee} on survey {surveyId} at event {id}.
        slots:
          attendee: requestBody.attendee
          surveyId: path.surveyId
          id: path.id
      - text: Add a new event survey respondent to survey {surveyId} of event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      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, like their score?
      - Can I update a respondent's record on an event survey after they submit?
      instructions:
      - text: Update respondent {respondentId} on survey {surveyId} at event {id}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          id: path.id
      - text: Set event survey respondent {respondentId}'s score to {score} (survey {surveyId}, event {id}).
        slots:
          respondentId: path.respondentId
          score: requestBody.score
          surveyId: path.surveyId
          id: path.id
      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 submit survey answers on behalf of an event survey respondent?
      - Can I record answers to a session or speaker question in an event survey?
      instructions:
      - text: Record answers {answers} to question {question} for respondent {respondentId} in survey {surveyId} at event {id}.
        slots:
          answers: requestBody.answers
          question: requestBody.question
          respondentId: path.respondentId
          surveyId: path.surveyId
          id: path.id
      - text: Submit event survey responses for respondent {respondentId} on survey {surveyId}, event {id}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          id: path.id
      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 did attendees answer on a specific survey for my event?
      - Can I pull the responses of one event survey only?
      instructions:
      - text: List responses to survey {surveyId} at event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: List 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 answer options for survey questions with very long choice lists?
      - Why are choices missing from a LargeChoices question, and how do I fetch them?
      instructions:
      - text: List large choices matching {filter}.
        slots:
          filter: query.filter
      - text: Fetch the choice list for large-choice survey questions.
      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 all my event and standalone surveys?
      - Can I list every survey question in the account in one call?
      instructions:
      - text: List all survey questions in my account.
      - text: List survey questions account-wide matching {filter}.
        slots:
          filter: query.filter
      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 my event or standalone surveys?
      - Can I get all survey respondents across the account created after a date?
      instructions:
      - text: List all survey respondents in my account.
      - text: List account-wide survey respondents 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:
      - Can I export every survey response, event and standalone, from the account?
      - What responses came in across all surveys this week?
      instructions:
      - text: List all survey responses in my account, event and standalone.
      - text: List account-wide survey responses matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List standalone surveys
      effect: read
      questions:
      - Which standalone surveys do I have that aren't tied to an event?
      - Can I list my standalone surveys with a filter?
      instructions:
      - text: List my standalone surveys.
      - text: List standalone surveys matching {filter}.
        slots:
          filter: query.filter
      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 for my standalone surveys?
      - Can I pull standalone survey responses after a certain date?
      instructions:
      - text: List standalone survey responses.
      - text: List standalone survey responses 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:
      - What invitation and reminder email templates does a standalone survey have?
      - Which email template should I pick to send a standalone survey?
      instructions:
      - text: List email templates for standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show the email templates configured on standalone survey {surveyId}.
        slots:
          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 questions does one of my standalone surveys ask?
      - Can I see the question list of a single standalone survey?
      instructions:
      - text: List questions in standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show standalone survey {surveyId}'s questions.
        slots:
          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 particular standalone survey?
      - Can I filter respondents of a single standalone survey?
      instructions:
      - text: List respondents to standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: List 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 attach a new standalone survey respondent to 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 on 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 standalone survey respondent {respondentId}'s status to {status} on survey {surveyId}.
        slots:
          respondentId: path.respondentId
          status: requestBody.status
          surveyId: path.surveyId
      - text: 'Mark respondent {respondentId} of standalone survey {surveyId} unsubscribed: {unsubscribed}.'
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          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 email to one respondent?
      - Can I email a respondent using a specific standalone 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} their standalone survey {surveyId} using template {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 for a standalone survey respondent
      effect: write
      questions:
      - How do I submit answers for a standalone survey respondent from another tool?
      - Can I record a new set of standalone survey responses via the API?
      instructions:
      - text: Submit standalone survey {surveyId} answers for respondent {respondentId}.
        slots:
          surveyId: path.surveyId
          respondentId: path.respondentId
      - text: Create responses {survey} for respondent {respondentId} on standalone survey {surveyId}.
        slots:
          survey: requestBody.survey
          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: Edit a standalone survey respondent's answers
      effect: write
      questions:
      - How do I correct answers a respondent already submitted on a standalone survey?
      - Can I change an existing standalone survey response?
      instructions:
      - text: Update response {responseId} for respondent {respondentId} on standalone survey {surveyId}.
        slots:
          responseId: path.responseId
          respondentId: path.respondentId
          surveyId: path.surveyId
      - text: Replace the answers in existing response {responseId} (survey {surveyId}, respondent {respondentId}) with {survey}.
        slots:
          responseId: path.responseId
          surveyId: path.surveyId
          respondentId: path.respondentId
          survey: requestBody.survey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List all event and standalone surveys
      effect: read
      questions:
      - What surveys, event and standalone, exist in my Cvent account?
      - Can I get one combined list of every survey in the account?
      instructions:
      - text: List every survey in my account, event and standalone.
      - text: List all account surveys matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'