# 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 Subusers API
  version: 1.0.0
extends: openapi/sendgrid-subusers-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: 9
- target: $.paths['/v3/subusers'].get
  update:
    x-apievangelist-phrasing:
      intent: List subusers
      effect: read
      questions:
      - Which subusers exist under my parent account?
      - Can I filter my subuser list by username or region?
      instructions:
      - text: List all my subusers.
      - text: Find subusers matching username {username}.
        slots:
          username: query.username
      - text: List subusers in region {region}.
        slots:
          region: query.region
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subuser
      effect: write
      questions:
      - How do I create a new subuser for a customer or team?
      - What do I need to supply when setting up a subuser, like IPs and a password?
      instructions:
      - text: Create subuser {username} with email {email}, password {password} and IPs {ips}.
        slots:
          username: requestBody.username
          email: requestBody.email
          password: requestBody.password
          ips: requestBody.ips
      - text: Set up a new subuser {username} in region {region}.
        slots:
          username: requestBody.username
          region: requestBody.region
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a subuser
      effect: destructive
      questions:
      - Can a deleted subuser ever be recovered?
      - How do I permanently remove a subuser account?
      instructions:
      - text: Permanently delete subuser {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      - text: Remove the subuser account {subuser_name} for good.
        slots:
          subuser_name: path.subuser_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a subuser
      effect: write
      questions:
      - Can I temporarily switch off a subuser without deleting it?
      - What turns a disabled subuser back on?
      instructions:
      - text: Disable subuser {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      - text: Set subuser {subuser_name} disabled to {disabled}.
        slots:
          subuser_name: path.subuser_name
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: View a subuser's credit allocation
      effect: read
      questions:
      - How many sending credits does a subuser have and how often do they reset?
      - Where do I see a subuser's credits overview?
      instructions:
      - text: Show the credits overview for subuser {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      - text: Get the credit allocation for {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}/credits'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a subuser's credit allocation
      effect: write
      questions:
      - Can I give a subuser a fixed number of credits that resets monthly?
      - Which credit allocation types can a subuser have?
      instructions:
      - text: Set subuser {subuser_name} to {type} credits with a total of {total} resetting {reset_frequency}.
        slots:
          subuser_name: path.subuser_name
          type: requestBody.type
          total: requestBody.total
          reset_frequency: requestBody.reset_frequency
      - text: Change the credit allocation type for {subuser_name} to {type}.
        slots:
          subuser_name: path.subuser_name
          type: requestBody.type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}/credits/remaining'].patch
  update:
    x-apievangelist-phrasing:
      intent: Adjust a subuser's remaining credits
      effect: write
      questions:
      - Can I top up or reduce the credits a subuser has left this period?
      - What adjusts only the remaining credit balance of a subuser, not its allocation?
      instructions:
      - text: Adjust the remaining credits for {subuser_name} by {allocation_update}.
        slots:
          subuser_name: path.subuser_name
          allocation_update: requestBody.allocation_update
      - text: Add {allocation_update} credits to what {subuser_name} has left.
        slots:
          allocation_update: requestBody.allocation_update
          subuser_name: path.subuser_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/{subuser_name}/ips'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign sending IPs to a subuser
      effect: write
      questions:
      - Can a subuser send from its own dedicated IP address?
      - How do I change which IPs a subuser's mail is sent from?
      instructions:
      - text: Update the IP addresses assigned to subuser {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      - text: Reassign sending IPs for {subuser_name}.
        slots:
          subuser_name: path.subuser_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/reputations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sender reputations for subusers
      effect: read
      questions:
      - What is the sender reputation score of each of my subusers?
      - Which subusers are hurting deliverability with bounces or spam reports?
      instructions:
      - text: Get sender reputations for subusers {usernames}.
        slots:
          usernames: query.usernames
      - text: Show the reputation score for subuser {usernames}.
        slots:
          usernames: query.usernames
      method: generated
      generated: '2026-09-24'