SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid IP Warmup API

5 actions 5 updates phrasing extends openapi/sendgrid-ip-warmup-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 5

$.info
$.paths['/v3/ips/warmup'].get
$.paths['/v3/ips/warmup'].post
$.paths['/v3/ips/warmup/{ip_address}'].get
$.paths['/v3/ips/warmup/{ip_address}'].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 Warmup API
  version: 1.0.0
extends: openapi/sendgrid-ip-warmup-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: 4
- target: $.paths['/v3/ips/warmup'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPs in warmup
      effect: read
      questions:
      - Which of my IP addresses are currently warming up?
      - Are any dedicated IPs still in warmup mode?
      instructions:
      - text: List all IPs currently in warmup.
      - text: Show my warming IP addresses.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Start warming up an IP address
      effect: write
      questions:
      - Can I gradually ramp up sending volume on a new dedicated IP?
      - What's the step to put an IP into warmup mode?
      instructions:
      - text: Start warming up IP {ip}.
        slots:
          ip: requestBody.ip
      - text: Put address {ip} into warmup mode.
        slots:
          ip: requestBody.ip
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/warmup/{ip_address}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get warmup status for an IP
      effect: read
      questions:
      - Is a specific IP still in warmup, and since when?
      - Can I check how far along one IP's warmup is?
      instructions:
      - text: Show warmup status for IP {ip_address}.
        slots:
          ip_address: path.ip_address
      - text: Check whether {ip_address} is warming up.
        slots:
          ip_address: path.ip_address
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/warmup/{ip_address}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop warming up an IP address
      effect: destructive
      questions:
      - Can I take an IP out of warmup early?
      - What happens when I stop warming up an address?
      instructions:
      - text: Stop warming up IP {ip_address}.
        slots:
          ip_address: path.ip_address
      - text: Remove {ip_address} from warmup mode.
        slots:
          ip_address: path.ip_address
      method: generated
      generated: '2026-09-24'