SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Account Provisioning Offering API

4 actions 4 updates phrasing extends openapi/sendgrid-offering-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 4

$.info

$.paths['/v3/partners/accounts/{accountID}/offerings'].get

$.paths['/v3/partners/accounts/{accountID}/offerings'].put

$.paths['/v3/partners/offerings'].get

OpenAPI Overlay

# 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 Account Provisioning Offering API
  version: 1.0.0
extends: openapi/sendgrid-offering-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: 3
- target: $.paths['/v3/partners/accounts/{accountID}/offerings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provisioned account's offerings
      effect: read
      questions:
      - What package and add-ons does one of my customer accounts have?
      - Can I check which offerings are assigned to a specific account?
      instructions:
      - text: Show offerings for account {accountID}.
        slots:
          accountID: path.accountID
      - text: Get the package and add-ons of account {accountID}.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/partners/accounts/{accountID}/offerings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a provisioned account's offerings
      effect: write
      questions:
      - Can I move a customer account to a different package?
      - Is it possible to add Marketing Campaigns or dedicated IPs to an account?
      instructions:
      - text: Set account {accountID} offerings to {offerings}.
        slots:
          accountID: path.accountID
          offerings: requestBody.offerings
      - text: Assign package and add-ons {offerings} to account {accountID}.
        slots:
          offerings: requestBody.offerings
          accountID: path.accountID
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/partners/offerings'].get
  update:
    x-apievangelist-phrasing:
      intent: List available offerings
      effect: read
      questions:
      - What packages and add-ons can I provision under my organization?
      - Which offerings are available to assign to accounts?
      instructions:
      - text: List all offerings available to my organization.
      - text: Show the packages I can provision.
      method: generated
      generated: '2026-09-24'