API Evangelist conversational phrasing for Cvent REST Surveys 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 Surveys API
  version: 1.0.0
extends: openapi/cvent-registration-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:
      - Can I pull every event survey response in my account in one feed?
      - Which event survey answers came in after a given date, across all events?
      instructions:
      - text: List event survey responses across all events and surveys.
      - text: List event survey responses from every event 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 surveys attached to an event
      effect: read
      questions:
      - What surveys are attached to one of my events?
      - How do I find the survey IDs for a specific event?
      instructions:
      - text: List surveys for event {id}.
        slots:
          id: path.id
      - text: Show 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 see the question list for one survey in one event?
      instructions:
      - text: List questions in survey {surveyId} of event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Show the event survey {surveyId} questions for 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 survey at my event?
      - Can I filter the people who answered one event survey?
      instructions:
      - text: List respondents to survey {surveyId} in 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 register an attendee as a respondent on an event survey before recording answers?
      - Can I create an event survey respondent for a contact or attendee?
      instructions:
      - text: Create a respondent for attendee {attendee} on survey {surveyId} in event {id}.
        slots:
          attendee: requestBody.attendee
          surveyId: path.surveyId
          id: path.id
      - text: Add contact {contact} as a respondent to event {id} survey {surveyId}.
        slots:
          contact: requestBody.contact
          id: path.id
          surveyId: path.surveyId
      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 the score or details of an existing event survey respondent?
      - Can I update a respondent's record on an event survey after they submit?
      instructions:
      - text: Update respondent {respondentId} on survey {surveyId} in event {id}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          id: path.id
      - text: Set event survey respondent {respondentId}'s score to {score} (event {id}, survey {surveyId}).
        slots:
          respondentId: path.respondentId
          score: requestBody.score
          id: path.id
          surveyId: path.surveyId
      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 question?
      - Can I submit survey answers about a session or speaker on behalf of an attendee?
      instructions:
      - text: Record answers {answers} to question {question} for respondent {respondentId} in event {id} survey {surveyId}.
        slots:
          answers: requestBody.answers
          question: requestBody.question
          respondentId: path.respondentId
          id: path.id
          surveyId: path.surveyId
      - 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 answers did attendees give on a specific event survey?
      - Can I export the responses to one survey in one event?
      instructions:
      - text: List responses to survey {surveyId} in event {id}.
        slots:
          surveyId: path.surveyId
          id: path.id
      - text: Get event {id} survey {surveyId} responses submitted after {after}.
        slots:
          id: path.id
          surveyId: path.surveyId
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/large-choices'].get
  update:
    x-apievangelist-phrasing:
      intent: List choices for large-choice questions
      effect: read
      questions:
      - Where do I get the answer options for a survey question with a very large choice list?
      - Can I filter the choices of a LargeChoices question type?
      instructions:
      - text: List large choices matching {filter}.
        slots:
          filter: query.filter
      - text: Get up to {limit} options for large-choice survey questions.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all survey questions in the account
      effect: read
      questions:
      - Can I list survey questions from both event and standalone surveys together?
      - Which survey questions exist across my whole account?
      instructions:
      - text: List every event and standalone survey question.
      - text: List account survey questions matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/respondents'].get
  update:
    x-apievangelist-phrasing:
      intent: List all survey respondents in the account
      effect: read
      questions:
      - Who has responded to any survey, event or standalone, in my account?
      - Can I page through all survey respondents updated since a date?
      instructions:
      - text: List respondents across all event and standalone surveys.
      - text: List account-wide survey respondents changed after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List all survey responses in the account
      effect: read
      questions:
      - Is there one feed of responses covering both event and standalone surveys?
      - What survey responses were submitted across my account before a given date?
      instructions:
      - text: List responses from all event and standalone surveys.
      - text: List account-wide survey responses submitted 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 I have that aren't tied to any event?
      - How do I find my standalone survey IDs?
      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 across standalone surveys
      effect: read
      questions:
      - Can I pull responses from all my standalone surveys at once?
      - What standalone survey answers arrived after a given date?
      instructions:
      - text: List responses across all standalone surveys.
      - text: List standalone survey responses received 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 a standalone survey's email templates
      effect: read
      questions:
      - What email templates are available for inviting people to a standalone survey?
      - How do I find the email template ID before sending a standalone survey email?
      instructions:
      - text: List email templates for standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show the invitation templates on 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 are in one of my standalone surveys?
      - Can I retrieve the question list for a survey not linked to an event?
      instructions:
      - text: List questions in standalone survey {surveyId}.
        slots:
          surveyId: path.surveyId
      - text: Show the first {limit} questions of 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 taken one of my standalone surveys?
      - 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 create a standalone survey respondent 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 with status {status}.
        slots:
          surveyId: path.surveyId
          status: requestBody.status
      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 a standalone survey respondent's status?
      instructions:
      - text: Set standalone survey {surveyId} respondent {respondentId} status to {status}.
        slots:
          surveyId: path.surveyId
          respondentId: path.respondentId
          status: requestBody.status
      - text: 'Mark respondent {respondentId} on 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 survey email 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} invitation 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 record a respondent's answers to a standalone survey?
      - Can I submit standalone survey answers that use looping choices?
      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} with looping choice {loopingChoice}.
        slots:
          respondentId: path.respondentId
          surveyId: path.surveyId
          loopingChoice: requestBody.loopingChoice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/standard-surveys/{surveyId}/respondents/{respondentId}/responses/{responseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a standalone survey response
      effect: write
      questions:
      - Can I correct an answer a respondent already submitted on a standalone survey?
      - How do 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 existing answer {responseId} for {respondentId} in survey {surveyId}.
        slots:
          responseId: path.responseId
          respondentId: path.respondentId
          surveyId: path.surveyId
      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, exist in my account?
      - Can I get one list of every survey I have?
      instructions:
      - text: List all event and standalone surveys in my account.
      - text: List account surveys matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'