SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid User Users API

10 actions 10 updates phrasing extends openapi/sendgrid-users-api-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 10

$.info
$.paths['/v3/user/account'].get
$.paths['/v3/user/credits'].get
$.paths['/v3/user/email'].get
$.paths['/v3/user/email'].put
$.paths['/v3/user/password'].put
$.paths['/v3/user/profile'].get
$.paths['/v3/user/profile'].patch
$.paths['/v3/user/username'].get
$.paths['/v3/user/username'].put

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 User Users API
  version: 1.0.0
extends: openapi/sendgrid-users-api-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/user/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account type and reputation
      effect: read
      questions:
      - What type of SendGrid account do I have and what's its reputation?
      - Where can I check my overall account reputation?
      instructions:
      - text: Show my account type and reputation.
      - text: Get my user account information.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my email credit balance
      effect: read
      questions:
      - How many emails can I still send before per-email charges kick in?
      - What is my current credit balance?
      instructions:
      - text: Show my remaining email credit balance.
      - text: Get my account's credits and when they reset.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account email address
      effect: read
      questions:
      - Which email address is on file for my account?
      - Can I check the contact email registered to my login?
      instructions:
      - text: Show the email address on file for my account.
      - text: Retrieve my account email.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/email'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the account email address
      effect: write
      questions:
      - How do I change the email address tied to my account?
      - Can I update my account email through the API?
      instructions:
      - text: Change my account email address to {email}.
        slots:
          email: requestBody.email
      - text: Update the email on file to {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/password'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my account password
      effect: write
      questions:
      - Can I change my password through the API?
      - What do I need to supply to reset my own password, besides the new one?
      instructions:
      - text: Change my password from {old_password} to {new_password}.
        slots:
          old_password: requestBody.old_password
          new_password: requestBody.new_password
      - text: Update my account password to {new_password}, confirming the current one {old_password}.
        slots:
          new_password: requestBody.new_password
          old_password: requestBody.old_password
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user profile
      effect: read
      questions:
      - What name, company and address are saved on my profile?
      - Where do I view my profile details?
      instructions:
      - text: Show my profile details.
      - text: Get the company and address saved on my user profile.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/profile'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update my user profile
      effect: write
      questions:
      - Can I update just my phone number on my profile without touching other fields?
      - Which profile fields can I edit, such as company, website or address?
      instructions:
      - text: Update my profile name to {first_name} {last_name}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
      - text: Set my profile company to {company} and website to {website}.
        slots:
          company: requestBody.company
          website: requestBody.website
      - text: Change my profile phone number to {phone}.
        slots:
          phone: requestBody.phone
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/username'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account username
      effect: read
      questions:
      - What is my current account username?
      - Can I look up the username I log in with?
      instructions:
      - text: Show my account username.
      - text: Retrieve the username for this account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/username'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my account username
      effect: write
      questions:
      - Is it possible to rename my account username?
      - How do I switch to a different login username?
      instructions:
      - text: Change my username to {username}.
        slots:
          username: requestBody.username
      - text: Rename my account login to {username}.
        slots:
          username: requestBody.username
      method: generated
      generated: '2026-09-24'