# 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 IM Group API
  version: 1.0.0
extends: openapi/zoom-im-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: 7
- target: $.paths['/im/group/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IM group
      effect: write
      questions:
      - How do I set up a new instant messaging group for my team?
      - Can I make an IM group searchable by people in the same domain?
      instructions:
      - text: Create an IM group named {name}.
        slots:
          name: requestBody.name
      - text: Create IM group {name} of type {type}, searchable by domain {option_search_by_domain}.
        slots:
          name: requestBody.name
          type: requestBody.type
          option_search_by_domain: requestBody.option_search_by_domain
      method: generated
      generated: '2026-09-24'
- target: $.paths['/im/group/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an IM group
      effect: destructive
      questions:
      - Can I remove an instant messaging group we don't use anymore?
      - What comes back after an IM group is deleted?
      instructions:
      - text: Delete IM group {id}.
        slots:
          id: requestBody.id
      - text: Remove the instant messaging group {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/im/group/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an IM group's name and search settings
      effect: write
      questions:
      - Can I rename an existing IM group or change its type?
      - Which search visibility options can I change on an IM group?
      instructions:
      - text: Rename IM group {id} to {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Change existing IM group {id} to type {type}.
        slots:
          id: requestBody.id
          type: requestBody.type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/im/group/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an IM group's info
      effect: read
      questions:
      - What settings does a particular IM group have?
      - Can I look up one instant messaging group by ID?
      instructions:
      - text: Get the info for IM group {id}.
        slots:
          id: requestBody.id
      - text: Show me the instant messaging group {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/im/group/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List all IM groups
      effect: read
      questions:
      - Which instant messaging groups exist on our account?
      - Can I see every IM group we've created?
      instructions:
      - text: List all IM groups on my account.
      - text: List IM 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['/im/group/member/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove members from an IM group
      effect: destructive
      questions:
      - Can I take people out of an instant messaging group?
      - Can I remove several IM group members in one call?
      instructions:
      - text: Remove members {member_ids} from IM group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      - text: Take {member_ids} out of instant messaging group {id}.
        slots:
          member_ids: requestBody.member_ids
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/im/group/member/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List an IM group's members
      effect: read
      questions:
      - Who is in a particular instant messaging group?
      - Can I page through an IM group's membership?
      instructions:
      - text: List the members of IM group {id}.
        slots:
          id: requestBody.id
      - text: Show page {page_number} of instant messaging group {id}'s members.
        slots:
          page_number: requestBody.page_number
          id: requestBody.id
      method: generated
      generated: '2026-09-24'