SendGrid · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Twilio SendGrid Mail Settings API
14 actions
14 updates
phrasing
extends
openapi/sendgrid-mail-settings-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.
What the actions change
x-apievangelist-phrasing
Targets 14
$.info
$.paths['/v3/mail_settings'].get
$.paths['/v3/mail_settings/address_whitelist'].get
$.paths['/v3/mail_settings/address_whitelist'].patch
$.paths['/v3/mail_settings/bounce_purge'].get
$.paths['/v3/mail_settings/bounce_purge'].patch
$.paths['/v3/mail_settings/footer'].get
$.paths['/v3/mail_settings/footer'].patch
$.paths['/v3/mail_settings/forward_bounce'].get
$.paths['/v3/mail_settings/forward_bounce'].patch
$.paths['/v3/mail_settings/forward_spam'].get
$.paths['/v3/mail_settings/forward_spam'].patch
$.paths['/v3/mail_settings/template'].get
$.paths['/v3/mail_settings/template'].patch
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 Mail Settings API
version: 1.0.0
extends: openapi/sendgrid-mail-settings-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: 13
- target: $.paths['/v3/mail_settings'].get
update:
x-apievangelist-phrasing:
intent: List all mail settings and whether they're on
effect: read
questions:
- Which mail settings are enabled on my SendGrid account?
- Can I page through the full list of mail settings with their descriptions?
instructions:
- text: List all my mail settings with their enabled status.
- text: Show {limit} mail settings starting at offset {offset}.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/address_whitelist'].get
update:
x-apievangelist-phrasing:
intent: View the address whitelist setting
effect: read
questions:
- Which email addresses or domains are exempt from suppression right now?
- Is my address whitelist turned on?
instructions:
- text: Show my current address whitelist mail setting.
- text: Tell me which addresses and domains are never suppressed.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/address_whitelist'].patch
update:
x-apievangelist-phrasing:
intent: Update the address whitelist setting
effect: write
questions:
- How can I make sure mail to my own domain is never suppressed?
- Can I turn the address whitelist on without changing its list of addresses?
instructions:
- text: 'Set my address whitelist to {list} and enable it: {enabled}.'
slots:
list: requestBody.list
enabled: requestBody.enabled
- text: Turn the address whitelist setting {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/bounce_purge'].get
update:
x-apievangelist-phrasing:
intent: View bounce purge settings
effect: read
questions:
- How long are hard and soft bounces kept before they are purged?
- Is automatic bounce purging enabled on my account?
instructions:
- text: Show my current bounce purge settings.
- text: Tell me the purge ages for my hard and soft bounce lists.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/bounce_purge'].patch
update:
x-apievangelist-phrasing:
intent: Change bounce purge ages
effect: write
questions:
- Can I automatically clear soft bounces after a set number of days?
- What controls the maximum age of contacts on my hard bounce list?
instructions:
- text: Purge soft bounces after {soft_bounces} days and hard bounces after {hard_bounces} days.
slots:
soft_bounces: requestBody.soft_bounces
hard_bounces: requestBody.hard_bounces
- text: Set bounce purge enabled to {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/footer'].get
update:
x-apievangelist-phrasing:
intent: View the email footer setting
effect: read
questions:
- What custom footer is currently added to the bottom of my emails?
- Is the footer mail setting switched on?
instructions:
- text: Show my current footer mail setting.
- text: Get the HTML and plain-text footer my emails use.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/footer'].patch
update:
x-apievangelist-phrasing:
intent: Set the footer added to every email
effect: write
questions:
- How do I add a custom footer to every email I send?
- Can I give the footer separate HTML and plain-text versions?
instructions:
- text: Set my email footer HTML to {html_content} and plain text to {plain_content}.
slots:
html_content: requestBody.html_content
plain_content: requestBody.plain_content
- text: Turn the footer mail setting {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/forward_bounce'].get
update:
x-apievangelist-phrasing:
intent: View bounce forwarding setting
effect: read
questions:
- Where are my bounce reports being forwarded?
- Is bounce forwarding enabled?
instructions:
- text: Show my forward bounce mail setting.
- text: Tell me which address receives forwarded bounce reports.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/forward_bounce'].patch
update:
x-apievangelist-phrasing:
intent: Forward bounce reports to an address
effect: write
questions:
- Can I get bounce reports forwarded to my own inbox?
- What happens to bounce forwarding if I leave the email blank?
instructions:
- text: Forward bounce reports to {email}.
slots:
email: requestBody.email
- text: Set bounce report forwarding enabled to {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/forward_spam'].get
update:
x-apievangelist-phrasing:
intent: View spam report forwarding setting
effect: read
questions:
- Which addresses receive forwarded spam reports?
- Is spam report forwarding turned on?
instructions:
- text: Show my forward spam mail setting.
- text: List the addresses my spam reports are forwarded to.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/forward_spam'].patch
update:
x-apievangelist-phrasing:
intent: Forward spam reports to addresses
effect: write
questions:
- Can I forward spam complaints to several email addresses?
- How do I stop spam reports being forwarded?
instructions:
- text: Forward spam reports to {email}.
slots:
email: requestBody.email
- text: Set spam report forwarding enabled to {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/template'].get
update:
x-apievangelist-phrasing:
intent: View the legacy email template setting
effect: read
questions:
- Is the legacy email template wrapping my messages?
- What HTML does my original-style legacy template use?
instructions:
- text: Show my legacy template mail setting.
- text: Get the HTML of the legacy template that wraps my emails.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/mail_settings/template'].patch
update:
x-apievangelist-phrasing:
intent: Update the legacy email template setting
effect: write
questions:
- How do I change the HTML wrapper of my legacy email template?
- Can I turn off the legacy template that wraps outgoing mail?
instructions:
- text: Set my legacy email template HTML to {html_content}.
slots:
html_content: requestBody.html_content
- text: Switch the legacy template mail setting to enabled {enabled}.
slots:
enabled: requestBody.enabled
method: generated
generated: '2026-09-24'