SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Deal Expiration API

3 actions 3 updates phrasing extends openapi/sendpulse-deal-expiration-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 3

$.info
$.paths['/deals/{dealId}/expiration'].put
$.paths['/deals/{dealId}/expiration'].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 CRM Public Deal Expiration API
  version: 1.0.0
extends: openapi/sendpulse-deal-expiration-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: 2
- target: $.paths['/deals/{dealId}/expiration'].put
  update:
    x-apievangelist-phrasing:
      intent: Set or change a deal's expiration
      effect: write
      questions:
      - Can I set a deadline on a deal and get notified before it expires?
      - What happens to a deal when its expiration date passes?
      instructions:
      - text: Set deal {dealId} to expire on {date} at {time}.
        slots:
          dealId: path.dealId
          date: requestBody.date
          time: requestBody.time
      - text: Make deal {dealId} expire {date} and notify {notifyIn} beforehand, then apply action {dealAction}.
        slots:
          dealId: path.dealId
          date: requestBody.date
          notifyIn: requestBody.notifyIn
          dealAction: requestBody.dealAction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/expiration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a deal's expiration
      effect: destructive
      questions:
      - Can I clear the expiration date from a deal?
      - What's the way to stop a deal from expiring?
      instructions:
      - text: Remove the expiration from deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Clear the deadline on deal {dealId}.
        slots:
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'