# 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 Users API
  version: 1.0.0
extends: openapi/cvent-users-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: 7
- target: $.paths['/account-user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List account user groups
      effect: read
      questions:
      - What user groups exist in our Cvent account?
      - Can I filter the account's user groups by name?
      instructions:
      - text: List account user groups matching {filter}.
        slots:
          filter: query.filter
      - text: Show the first {limit} user groups in my account.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account user group
      effect: write
      questions:
      - How do I set up a new user group for our planners?
      - Can I create a user group with a description?
      instructions:
      - text: Create a user group named {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add user group {name} described as {description} with ID {id}.
        slots:
          name: requestBody.name
          description: requestBody.description
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account user group
      effect: read
      questions:
      - What are the details of a particular user group?
      - How do I look up one account user group?
      instructions:
      - text: Get user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Show the name and description of group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a user group
      effect: write
      questions:
      - How do I rename an existing user group?
      - Can I change a user group's description?
      instructions:
      - text: Rename user group {userGroupId} to {name}.
        slots:
          userGroupId: path.userGroupId
          name: requestBody.name
      - text: Update group {userGroupId} description to {description}.
        slots:
          userGroupId: path.userGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account user group
      effect: destructive
      questions:
      - How do I delete a user group we no longer need?
      - Can I remove an entire user group from the account?
      instructions:
      - text: Delete user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Remove group {userGroupId} from my account.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a user group
      effect: write
      questions:
      - How do I put a user into a user group?
      - Can I give a colleague a group's access by adding them to it?
      instructions:
      - text: Add user {userId} to group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Make {userId} a member of user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a user group
      effect: destructive
      questions:
      - How do I take a user out of a user group?
      - Can I revoke someone's group membership without deleting the group?
      instructions:
      - text: Remove user {userId} from group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Take {userId} out of user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'