SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sendpulse Configuration API

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

$.info
$.paths['/sms/senders'].get
$.paths['/smtp/ips'].get
$.paths['/smtp/senders'].get
$.paths['/v2/email-service/smtp/sender_domains'].get
$.paths['/senders'].post
$.paths['/v2/email-service/smtp/sender_domains/{domain}'].post
$.paths['/viber/senders'].get
$.paths['/viber/senders/{id}'].get
$.paths['/push/websites/{id}/code'].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 Sendpulse Configuration API
  version: 1.0.0
extends: openapi/sendpulse-configuration-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: 9
- target: $.paths['/sms/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS sender IDs
      effect: read
      questions:
      - Which SMS sender IDs are registered on my account?
      - What sender names can I use for text messages?
      instructions:
      - text: List my SMS sender IDs.
      - text: Show the sender names available for SMS.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/ips'].get
  update:
    x-apievangelist-phrasing:
      intent: List the IP addresses used to send email
      effect: read
      questions:
      - Which IP addresses does my transactional email go out from?
      - Can I see the sending IPs assigned to my SMTP account?
      instructions:
      - text: List my SMTP sending IP addresses.
      - text: Show the IPs my email is sent from.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender email addresses
      effect: read
      questions:
      - Which sender email addresses are set up on my account?
      - What from-addresses can I use for SMTP email?
      instructions:
      - text: List my sender email addresses.
      - text: Show the from-addresses configured for SMTP.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/smtp/sender_domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed sender domains for SMTP
      effect: read
      questions:
      - Which domains am I allowed to send SMTP email from?
      - Has my sending domain been added to the allowed list?
      instructions:
      - text: List my allowed SMTP sender domains.
      - text: Show which domains are approved for sending email.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender email address
      effect: write
      questions:
      - How do I add a new from-address for sending email?
      - Can I register a sender email with a display name?
      instructions:
      - text: Add sender {email} with the name {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      - text: Register {email} as a new sending address labelled {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/smtp/sender_domains/{domain}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an allowed sender domain for SMTP
      effect: write
      questions:
      - Can I add my own domain so I can send SMTP email from it?
      - What's the way to allow a new sending domain?
      instructions:
      - text: Add {domain} as an allowed SMTP sender domain.
        slots:
          domain: path.domain
      - text: Allow email sending from domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List Viber sender names
      effect: read
      questions:
      - Which Viber sender names do I have?
      - What sender profiles are available for Viber campaigns?
      instructions:
      - text: List my Viber sender names.
      - text: Show the Viber senders on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber/senders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Viber sender name's profile
      effect: read
      questions:
      - Can I see the details of one Viber sender name?
      - What status is my Viber sender profile in?
      instructions:
      - text: Show the profile of Viber sender {id}.
        slots:
          id: path.id
      - text: Get details for Viber sender name {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites/{id}/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the web push JS code for a website
      effect: read
      questions:
      - Where do I get the JavaScript snippet to enable push notifications on my site?
      - Can I retrieve the push integration code for one website?
      instructions:
      - text: Get the web push JS code for website {id}.
        slots:
          id: path.id
      - text: Give me the push subscription snippet to install on site {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'