Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Unsubscribed Emails API

4 actions 4 updates phrasing extends openapi/close-unsubscribed-emails-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/unsubscribe/email/'].get
$.paths['/unsubscribe/email/'].post
$.paths['/unsubscribe/email/{email_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 Close Unsubscribed Emails API
  version: 1.0.0
extends: openapi/close-unsubscribed-emails-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/unsubscribe/email/'].get
  update:
    x-apievangelist-phrasing:
      intent: List unsubscribed email addresses
      effect: read
      questions:
      - Which email addresses have unsubscribed?
      - Can I see our full email opt-out list?
      instructions:
      - text: List all unsubscribed email addresses.
      - text: Show the email opt-out list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unsubscribe/email/'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe an email address
      effect: write
      questions:
      - How do I stop sending emails to someone who opted out elsewhere?
      - Can I sync an unsubscribe from our mailing list tool?
      instructions:
      - text: Unsubscribe {email}.
        slots:
          email: requestBody.email
      - text: Add {email} to the opt-out list.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unsubscribe/email/{email_address}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Resubscribe an email address
      effect: destructive
      questions:
      - Can I resubscribe someone who unsubscribed by mistake?
      - Which call removes an address from the opt-out list?
      instructions:
      - text: Resubscribe {email_address}.
        slots:
          email_address: path.email_address
      - text: Remove {email_address} from the unsubscribe list.
        slots:
          email_address: path.email_address
      method: generated
      generated: '2026-09-26'