SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sendpulse Compliance API

7 actions 7 updates phrasing extends openapi/sendpulse-compliance-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 7

$.info
$.paths['/sms/black_list'].get
$.paths['/sms/black_list'].post
$.paths['/sms/black_list'].delete
$.paths['/v2/viber-service/phone-exception'].get
$.paths['/v2/viber-service/phone-exception'].post
$.paths['/v2/viber-service/phone-exception'].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 Compliance API
  version: 1.0.0
extends: openapi/sendpulse-compliance-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: 6
- target: $.paths['/sms/black_list'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers on the SMS blacklist
      effect: read
      questions:
      - Which phone numbers are blocked from receiving my SMS?
      - Can I see the SMS blacklist?
      instructions:
      - text: List the numbers on my SMS blacklist.
      - text: Show who is blocked from SMS campaigns.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/black_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Add phone numbers to the SMS blacklist
      effect: write
      questions:
      - How do I stop SMS from going to certain phone numbers?
      - Can I blacklist numbers for SMS with a reason?
      instructions:
      - text: Add {phones} to the SMS blacklist with the note {description}.
        slots:
          phones: requestBody.phones
          description: requestBody.description
      - text: Block SMS to {phones} because {description}.
        slots:
          phones: requestBody.phones
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/black_list'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove phone numbers from the SMS blacklist
      effect: destructive
      questions:
      - Can I unblock a number so it receives SMS again?
      - What's the way to take numbers off the SMS blacklist?
      instructions:
      - text: Remove {phones} from the SMS blacklist.
        slots:
          phones: requestBody.phones
      - text: Unblock SMS for {phones}.
        slots:
          phones: requestBody.phones
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/viber-service/phone-exception'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers on the Viber blacklist
      effect: read
      questions:
      - Which phone numbers are excluded from my Viber campaigns?
      - Can I page through the Viber blacklist?
      instructions:
      - text: List the numbers on my Viber blacklist.
      - text: Show {limit} Viber-blocked numbers from offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/viber-service/phone-exception'].post
  update:
    x-apievangelist-phrasing:
      intent: Add phone numbers to the Viber blacklist
      effect: write
      questions:
      - How do I exclude a phone number from Viber messages?
      - Can I add numbers to the Viber exception list?
      instructions:
      - text: Add {phones} to the Viber blacklist.
        slots:
          phones: requestBody.phones
      - text: Block Viber messages to {phones} with the note {description}.
        slots:
          phones: requestBody.phones
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/viber-service/phone-exception'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove phone numbers from the Viber blacklist
      effect: destructive
      questions:
      - Can I let a blocked number receive Viber campaigns again?
      - What's the way to remove numbers from the Viber exception list?
      instructions:
      - text: Remove {phones} from the Viber blacklist.
        slots:
          phones: requestBody.phones
      - text: Unblock Viber for {phones}.
        slots:
          phones: requestBody.phones
      method: generated
      generated: '2026-10-01'