# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Suppressions Unsubscribe Groups API
  version: 1.0.0
extends: openapi/sendgrid-unsubscribe-groups-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: 5
- target: $.paths['/v3/asm/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List unsubscribe groups
      effect: read
      questions:
      - What unsubscribe groups have I created for my recipients to opt out of?
      - Can I fetch several suppression groups at once by their IDs?
      instructions:
      - text: List all my unsubscribe groups.
      - text: Show suppression groups {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an unsubscribe group
      effect: write
      questions:
      - Can I let recipients opt out of just one type of email, like newsletters?
      - Is it possible to make a new suppression group the default?
      instructions:
      - text: Create an unsubscribe group named {name}.
        slots:
          name: requestBody.name
      - text: Create suppression group {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an unsubscribe group
      effect: read
      questions:
      - How many people have unsubscribed from a particular group?
      - What's the description of one of my suppression groups?
      instructions:
      - text: Show unsubscribe group {group_id}.
        slots:
          group_id: path.group_id
      - text: Get details for suppression group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an unsubscribe group
      effect: destructive
      questions:
      - What happens to one-click unsubscribes after I delete a suppression group?
      - Can I remove an unsubscribe group I no longer use?
      instructions:
      - text: Delete unsubscribe group {group_id}.
        slots:
          group_id: path.group_id
      - text: Remove suppression group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an unsubscribe group
      effect: write
      questions:
      - Can I rename a suppression group or change its description?
      - Is it possible to make an existing unsubscribe group the default?
      instructions:
      - text: Rename unsubscribe group {group_id} to {name}.
        slots:
          group_id: path.group_id
          name: requestBody.name
      - text: 'Set suppression group {group_id} as default: {is_default}.'
        slots:
          group_id: path.group_id
          is_default: requestBody.is_default
      method: generated
      generated: '2026-09-24'