SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid IP Access Management API

7 actions 7 updates phrasing extends openapi/sendgrid-ip-access-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v3/access_settings/activity'].get
$.paths['/v3/access_settings/whitelist'].get
$.paths['/v3/access_settings/whitelist'].post
$.paths['/v3/access_settings/whitelist'].delete
$.paths['/v3/access_settings/whitelist/{rule_id}'].get
$.paths['/v3/access_settings/whitelist/{rule_id}'].delete

OpenAPI Overlay

Raw ↑
# 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 IP Access Management API
  version: 1.0.0
extends: openapi/sendgrid-ip-access-management-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/access_settings/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Review recent account access attempts
      effect: read
      questions:
      - Which IP addresses have recently tried to log in to my account or call the API?
      - Can I audit recent access attempts, including ones that were blocked?
      instructions:
      - text: Show recent access attempts on my account.
      - text: List the last {limit} IPs that tried to access my account.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/access_settings/whitelist'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPs allowed to access the account
      effect: read
      questions:
      - Which IP addresses are currently on my account's allow list?
      - When was each allowed IP added?
      instructions:
      - text: List every IP on my access allow list.
      - text: Show all allowed IPs with their rule IDs.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/access_settings/whitelist'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow IP addresses to access the account
      effect: write
      questions:
      - How do I restrict account access to my office IP addresses?
      - Can I add several IPs or a CIDR range to the allow list at once?
      instructions:
      - text: Add {ips} to my IP allow list.
        slots:
          ips: requestBody.ips
      - text: 'Allow access to my account from these IPs: {ips}.'
        slots:
          ips: requestBody.ips
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/access_settings/whitelist'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several IPs from the allow list
      effect: destructive
      questions:
      - Can I remove a batch of IPs from the allow list in one request?
      - What IDs do I pass to drop multiple allowed addresses?
      instructions:
      - text: Remove the allowed IPs with rule IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk delete allow-list entries {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/access_settings/whitelist/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one allowed IP rule
      effect: read
      questions:
      - What IP address does a specific allow-list rule ID cover?
      - When was a particular allowed IP added or last updated?
      instructions:
      - text: Show allowed IP rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Get the address and dates for allow-list entry {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/access_settings/whitelist/{rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one IP from the allow list
      effect: destructive
      questions:
      - How can I revoke access for a single allowed IP address?
      - Is there a way to delete just one allow-list rule by its ID?
      instructions:
      - text: Remove allow-list rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Stop allowing the single IP with rule ID {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-24'