MailerLite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MailerLite Subscribers API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/subscribers'].get
$.paths['/api/subscribers'].post
$.paths['/api/subscribers/{subscriber}'].get
$.paths['/api/subscribers/{subscriber}'].put
$.paths['/api/subscribers/{subscriber}'].delete
$.paths['/api/subscribers/{id}/forget'].post
$.paths['/api/subscribers/{id}/activity-log'].get

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 MailerLite Subscribers API
  version: 1.0.0
extends: openapi/mailerlite-subscribers-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: 7
- target: $.paths['/api/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers
      effect: read
      questions:
      - How do I page through all my subscribers?
      - Can I list only unsubscribed or bounced subscribers?
      - Is there a limit on how many subscribers come back per page?
      instructions:
      - text: List my subscribers with status {status}.
        slots:
          status: query.filter[status]
      - text: Show the next {limit} subscribers after cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      - text: List all my subscribers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a subscriber by email
      effect: write
      questions:
      - How do I add a new subscriber to my MailerLite list?
      - Can I add someone and put them into groups at the same time?
      - What happens if I add an email that is already subscribed?
      instructions:
      - text: Add {email} as a subscriber.
        slots:
          email: requestBody.email
      - text: Add {email} to groups {groups}.
        slots:
          email: requestBody.email
          groups: requestBody.groups
      - text: Create or update subscriber {email} with fields {fields} and status {status}.
        slots:
          email: requestBody.email
          fields: requestBody.fields
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers/{subscriber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a subscriber by ID or email
      effect: read
      questions:
      - Can I look up a subscriber by their email address?
      - What details are stored for one particular subscriber?
      instructions:
      - text: Look up subscriber {subscriber}.
        slots:
          subscriber: path.subscriber
      - text: Get the profile of subscriber {subscriber} by ID or email.
        slots:
          subscriber: path.subscriber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers/{subscriber}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing subscriber
      effect: write
      questions:
      - How do I change the details of a subscriber who already exists?
      - Can I edit an existing subscriber record using their ID or email?
      instructions:
      - text: Update the existing subscriber {subscriber}.
        slots:
          subscriber: path.subscriber
      - text: Edit the record of subscriber {subscriber} that is already on my list.
        slots:
          subscriber: path.subscriber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers/{subscriber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscriber
      effect: destructive
      questions:
      - How do I delete a subscriber from my account?
      - Can I remove a contact without doing a full GDPR forget?
      instructions:
      - text: Delete subscriber {subscriber}.
        slots:
          subscriber: path.subscriber
      - text: Remove {subscriber} from my subscribers.
        slots:
          subscriber: path.subscriber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers/{id}/forget'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently forget a subscriber for GDPR
      effect: destructive
      questions:
      - How do I honor a GDPR right-to-be-forgotten request for a subscriber?
      - Can I erase all of a subscriber's personal data, not just delete them?
      instructions:
      - text: Forget subscriber {id} under GDPR.
        slots:
          id: path.id
      - text: Erase all personal data for subscriber {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/subscribers/{id}/activity-log'].get
  update:
    x-apievangelist-phrasing:
      intent: View a subscriber's activity log
      effect: read
      questions:
      - What has a subscriber done recently, like opens and clicks?
      - Where can I see the activity history for one subscriber?
      instructions:
      - text: Show the activity log for subscriber {id}.
        slots:
          id: path.id
      - text: Get the activity history of subscriber {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'