SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sendpulse Templates API

6 actions 6 updates phrasing extends openapi/sendpulse-templates-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['/template'].post
$.paths['/template/edit/{id}'].post
$.paths['/template/{template_id}'].get
$.paths['/template/slug/{name_slug}'].get
$.paths['/templates'].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 Templates API
  version: 1.0.0
extends: openapi/sendpulse-templates-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['/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template from HTML
      effect: write
      questions:
      - How do I upload my own HTML as a reusable email template?
      - Can I create a template in a specific language?
      instructions:
      - text: Create an email template named {name} from HTML {body}.
        slots:
          name: requestBody.name
          body: requestBody.body
      - text: 'Save this HTML as a new {lang} template: {body}.'
        slots:
          lang: requestBody.lang
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/edit/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing email template's HTML
      effect: write
      questions:
      - Can I replace the HTML of a template I already created?
      - What's the way to edit an existing email template?
      instructions:
      - text: Replace the HTML of template {id} with {body}.
        slots:
          id: path.id
          body: requestBody.body
      - text: 'Edit template {id} to use this {lang} markup: {body}.'
        slots:
          id: path.id
          lang: requestBody.lang
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/{template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template by ID
      effect: read
      questions:
      - What metadata is stored for one of my email templates?
      - Can I fetch a template by its numeric ID?
      instructions:
      - text: Show email template {template_id}.
        slots:
          template_id: path.template_id
      - text: Get the {lang} version of template {template_id}.
        slots:
          lang: query.lang
          template_id: path.template_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/slug/{name_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template by its name slug
      effect: read
      questions:
      - Can I look up a template by its name slug instead of the ID?
      - Which template matches a given slug?
      instructions:
      - text: Get the template with slug {name_slug}.
        slots:
          name_slug: path.name_slug
      - text: Find email template by name slug {name_slug}.
        slots:
          name_slug: path.name_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates
      effect: read
      questions:
      - Which email templates do I have available?
      - Can I list only my own active templates, not the system ones?
      instructions:
      - text: List all my email templates.
      - text: 'List templates owned by {owner}, active only: {only_active}.'
        slots:
          owner: query.owner
          only_active: query.only_active
      method: generated
      generated: '2026-10-01'