Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Suppressions API

6 actions 6 updates phrasing extends openapi/leadping-suppressions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/suppressions'].post

$.paths['/suppressions/release'].post

$.paths['/suppressions/check'].post

$.paths['/suppressions/all/my'].post

$.paths['/suppressions/{id}'].get

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 Leadping Suppressions API
  version: 1.0.0
extends: openapi/leadping-suppressions-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: 5
- target: $.paths['/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Block a recipient from outreach
      effect: write
      questions:
      - How do I stop contacting someone who asked to opt out?
      - Can I suppress a phone number for SMS only?
      instructions:
      - text: Suppress phone number {phoneNumber}.
        slots:
          phoneNumber: requestBody.phoneNumber
      - text: Block {email} on the {channel} channel because {reason}.
        slots:
          email: requestBody.email
          channel: requestBody.channel
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/release'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a recipient suppression
      effect: write
      questions:
      - How do I allow a previously opted-out contact to be messaged again?
      - Can I lift a suppression on one channel?
      instructions:
      - text: Release the suppression on {phoneNumber}.
        slots:
          phoneNumber: requestBody.phoneNumber
      - text: Unblock {email} for {channel}.
        slots:
          email: requestBody.email
          channel: requestBody.channel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a recipient is suppressed
      effect: read
      questions:
      - Am I allowed to text this phone number, or is it suppressed?
      - Is a given email blocked from outreach?
      instructions:
      - text: Check whether {phoneNumber} is suppressed.
        slots:
          phoneNumber: requestBody.phoneNumber
      - text: Check whether {email} is blocked on {channel}.
        slots:
          email: requestBody.email
          channel: requestBody.channel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List suppressed recipients
      effect: read
      questions:
      - Who is on my organization's do-not-contact list?
      - Can I page through all suppression entries?
      instructions:
      - text: List my organization's suppressions.
      - text: Search the do-not-contact list for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a suppression entry
      effect: read
      questions:
      - Why and when was a particular recipient suppressed?
      - How do I view a single suppression record's audit details?
      instructions:
      - text: Show suppression entry {id}.
        slots:
          id: path.id
      - text: Get the reason and channel for suppression {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'