SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Provisioning Account API

5 actions 5 updates phrasing extends openapi/sendgrid-account-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/partners/accounts'].get
$.paths['/v3/partners/accounts'].post
$.paths['/v3/partners/accounts/{accountID}'].delete
$.paths['/v3/partners/accounts/{accountID}/sso'].post

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 Provisioning Account API
  version: 1.0.0
extends: openapi/sendgrid-account-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/partners/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts under my partner organization
      effect: read
      questions:
      - Which customer accounts exist under my partner organization?
      - Can I page through the accounts I manage as a partner?
      instructions:
      - text: List all accounts under my organization.
      - text: Show {limit} partner accounts starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/partners/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer account with offerings
      effect: write
      questions:
      - How do I provision a new customer account under my partner organization?
      - Can I create a test account instead of a live one?
      instructions:
      - text: Create an account with offerings {offerings}.
        slots:
          offerings: requestBody.offerings
      - text: Create a test account with profile {profile} and offerings {offerings}, test flag {T-Test-Account}.
        slots:
          profile: requestBody.profile
          offerings: requestBody.offerings
          T-Test-Account: header.T-Test-Account
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/partners/accounts/{accountID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a customer account
      effect: destructive
      questions:
      - What happens to API keys and SSO when a partner account is deleted?
      - Is deleting a customer account irreversible?
      instructions:
      - text: Delete account {accountID}.
        slots:
          accountID: path.accountID
      - text: Permanently remove customer account {accountID} from my organization.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/partners/accounts/{accountID}/sso'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in to a customer account via SSO
      effect: write
      questions:
      - Can I log into a customer's account as its SSO admin?
      - Do teammates and subusers of that account get in through partner SSO too?
      instructions:
      - text: Log me into account {accountID} with single sign-on.
        slots:
          accountID: path.accountID
      - text: Authenticate as the admin of account {accountID} via SSO.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-09-24'