# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoom REST Group API
  version: 1.0.0
extends: openapi/zoom-group-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/group/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I set up a new group of users on my account?
      - What do I need to name a group when creating it?
      instructions:
      - text: Create a group named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new user group called {name} on the account.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - Can I remove a group I no longer need?
      - What do I get back after deleting a group?
      instructions:
      - text: Delete group {id}.
        slots:
          id: requestBody.id
      - text: Remove the user group {id} from the account.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a user group
      effect: write
      questions:
      - Can I change the name of an existing group?
      - Is editing a group limited to its name?
      instructions:
      - text: Rename group {id} to {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Edit the existing group {id} so it is called {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a user group's info
      effect: read
      questions:
      - What information is stored for a particular group?
      - Can I look up one group by its ID?
      instructions:
      - text: Get the info for group {id}.
        slots:
          id: requestBody.id
      - text: Show me the details of user group {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List all user groups
      effect: read
      questions:
      - Which groups exist on my Zoom account?
      - Can I see every user group we've set up?
      instructions:
      - text: List all groups on my account.
      - text: List user groups using API key {api_key} and secret {api_secret}.
        slots:
          api_key: requestBody.api_key
          api_secret: requestBody.api_secret
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/member/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a user group
      effect: write
      questions:
      - How can I put several users into a group at once?
      - Can I add existing users to a group by their IDs?
      instructions:
      - text: Add users {member_ids} to group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      - text: Put members {member_ids} into user group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/member/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove members from a user group
      effect: destructive
      questions:
      - Can I take users out of a group without deleting the group?
      - Does removing someone from a group delete their user account?
      instructions:
      - text: Remove users {member_ids} from group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      - text: Take members {member_ids} out of user group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/group/member/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a user group's members
      effect: read
      questions:
      - Who belongs to a particular group?
      - Can I page through the membership of a large group?
      instructions:
      - text: List the members of group {id}.
        slots:
          id: requestBody.id
      - text: Show page {page_number} of user group {id}'s members.
        slots:
          page_number: requestBody.page_number
          id: requestBody.id
      method: generated
      generated: '2026-09-24'