SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Pop-up Popup API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/public/api/popups/conditions'].get
$.paths['/public/api/popups/list/quiz/{projectId}'].get
$.paths['/public/api/popups/list/{projectId}'].get
$.paths['/public/api/popups/{popupId}/set-state'].post
$.paths['/public/api/popups/{popupId}'].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 SendPulse Pop-up Popup API
  version: 1.0.0
extends: openapi/sendpulse-popup-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/public/api/popups/conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available pop-up display conditions
      effect: read
      questions:
      - What display conditions can I use to trigger a pop-up?
      - Which rules control when a pop-up appears on my site?
      instructions:
      - text: List the available pop-up display conditions.
      - text: Show every condition that can trigger a pop-up.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/popups/list/quiz/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List quiz pop-ups in a project
      effect: read
      questions:
      - Which quiz pop-ups do I have on a project?
      - Can I list only the quiz-type pop-ups for one site?
      instructions:
      - text: List quiz pop-ups in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the first {first} quiz pop-ups for project {projectId}.
        slots:
          first: query.first
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/popups/list/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List pop-ups in a project
      effect: read
      questions:
      - What pop-ups are set up for my website project?
      - Can I page through all pop-ups in one project?
      instructions:
      - text: List all pop-ups in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show pop-ups for project {projectId} from offset {offset}.
        slots:
          projectId: path.projectId
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/popups/{popupId}/set-state'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a pop-up
      effect: write
      questions:
      - Can I turn a pop-up off on my website without deleting it?
      - How do I re-enable a disabled pop-up?
      instructions:
      - text: Disable pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Set pop-up {popupId} enabled to {is_enabled}.
        slots:
          popupId: path.popupId
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/popups/{popupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pop-up
      effect: destructive
      questions:
      - Can I permanently delete a pop-up?
      - What's the way to remove a pop-up I no longer use?
      instructions:
      - text: Delete pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Permanently remove pop-up {popupId} from my site.
        slots:
          popupId: path.popupId
      method: generated
      generated: '2026-10-01'