SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sendpulse Tags API

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

$.info
$.paths['/tags'].get
$.paths['/tags'].post
$.paths['/tags/{id}'].put
$.paths['/tags/{id}'].delete
$.paths['/tags/pin/email'].post
$.paths['/tags/pin/phone'].post
$.paths['/tags/unpin/email'].post
$.paths['/tags/unpin/phone'].post

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 Tags API
  version: 1.0.0
extends: openapi/sendpulse-tags-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: 8
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List email and phone tags
      effect: read
      questions:
      - What tags have I created in my account?
      - Can I see all tags with their colors?
      instructions:
      - text: List all my tags.
      - text: Show every tag in the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a colored tag
      effect: write
      questions:
      - How do I create a new tag with a color?
      - Can I add a tag to use for labeling subscribers?
      instructions:
      - text: Create a tag {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Add a new {color} tag called {name}.
        slots:
          color: requestBody.color
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a tag
      effect: write
      questions:
      - Can I change the name and color of an existing tag?
      - Is it possible to recolor a tag I already made?
      instructions:
      - text: Update tag {id} to name {name} and color {color}.
        slots:
          id: path.id
          name: requestBody.name
          color: requestBody.color
      - text: Rename tag {id} to {name} keeping color {color}.
        slots:
          id: path.id
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I delete a tag from my account?
      - Can I remove a tag I no longer need?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Remove tag {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/pin/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign tags to an email address
      effect: write
      questions:
      - Can I label a subscriber's email address with tags?
      - Is it possible to assign several tags to one email at once?
      instructions:
      - text: Tag email {email} with {tags}.
        slots:
          email: requestBody.email
          tags: requestBody.tags
      - text: Assign tags {tags} to the address {email}.
        slots:
          tags: requestBody.tags
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/pin/phone'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign tags to a phone number
      effect: write
      questions:
      - Can I attach tags to an SMS subscriber's phone number?
      - Which call labels a phone number with tags?
      instructions:
      - text: Tag phone number {phone} with {tags}.
        slots:
          phone: requestBody.phone
          tags: requestBody.tags
      - text: Assign tags {tags} to phone {phone}.
        slots:
          tags: requestBody.tags
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/unpin/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an email address
      effect: write
      questions:
      - How do I take a tag off an email address?
      - Can I unassign several tags from one email at a time?
      instructions:
      - text: Remove tags {tags} from email {email}.
        slots:
          tags: requestBody.tags
          email: requestBody.email
      - text: Untag the address {email} of {tags}.
        slots:
          email: requestBody.email
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags/unpin/phone'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a phone number
      effect: write
      questions:
      - Can I unassign tags from a phone number?
      - What's the way to clear a tag off an SMS subscriber's phone?
      instructions:
      - text: Remove tags {tags} from phone {phone}.
        slots:
          tags: requestBody.tags
          phone: requestBody.phone
      - text: Untag phone number {phone} of {tags}.
        slots:
          phone: requestBody.phone
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'