# 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 API
  version: 1.0.0
extends: openapi/sendgrid-suppressions-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: 6
- target: $.paths['/v3/asm/groups/{group_id}/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressions in an unsubscribe group
      effect: read
      questions:
      - Which email addresses have unsubscribed from a particular group?
      - Can I see every suppressed address in one suppression group?
      instructions:
      - text: List all suppressed addresses in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show who unsubscribed from suppression group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add emails to an unsubscribe group
      effect: write
      questions:
      - How do I unsubscribe addresses from a specific group?
      - What happens if I add suppressions to a group that doesn't exist?
      instructions:
      - text: Add {recipient_emails} to suppression group {group_id}.
        slots:
          recipient_emails: requestBody.recipient_emails
          group_id: path.group_id
      - text: 'Unsubscribe these addresses from group {group_id}: {recipient_emails}.'
        slots:
          group_id: path.group_id
          recipient_emails: requestBody.recipient_emails
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}/suppressions/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email from an unsubscribe group
      effect: destructive
      questions:
      - Can I resubscribe someone to a group they unsubscribed from?
      - What happens once an address is removed from a suppression group?
      instructions:
      - text: Remove {email} from suppression group {group_id}.
        slots:
          email: path.email
          group_id: path.group_id
      - text: Resubscribe {email} to group {group_id}.
        slots:
          email: path.email
          group_id: path.group_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/groups/{group_id}/suppressions/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which emails are suppressed in a group
      effect: read
      questions:
      - Given a list of addresses, which ones are unsubscribed from a group?
      - Is there a way to check several emails against one suppression group?
      instructions:
      - text: Check which of {recipient_emails} are suppressed in group {group_id}.
        slots:
          recipient_emails: requestBody.recipient_emails
          group_id: path.group_id
      - text: 'Search group {group_id} for these addresses: {recipient_emails}.'
        slots:
          group_id: path.group_id
          recipient_emails: requestBody.recipient_emails
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all group suppressions
      effect: read
      questions:
      - What unsubscribes exist across all my suppression groups?
      - Can I pull every group suppression on my account?
      instructions:
      - text: List all suppressions across every unsubscribe group.
      - text: Show all group unsubscribes on my account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/suppressions/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups an email has unsubscribed from
      effect: read
      questions:
      - Which groups has a particular person unsubscribed from?
      - Can I look up one email's suppression groups?
      instructions:
      - text: Show the groups {email} has unsubscribed from.
        slots:
          email: path.email
      - text: Get all suppression groups for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'