SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Contact tags API

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

$.info
$.paths['/contact-tags/{tagId}/contact/{contactId}'].post
$.paths['/contact-tags/{tagId}/contact/{contactId}'].delete
$.paths['/contact-tags'].get
$.paths['/contact-tags'].post
$.paths['/contact-tags/{tagId}'].put
$.paths['/contact-tags/{tagId}'].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 CRM Public Contact tags API
  version: 1.0.0
extends: openapi/sendpulse-contact-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: 6
- target: $.paths['/contact-tags/{tagId}/contact/{contactId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tag to a CRM contact
      effect: write
      questions:
      - How do I tag a contact in the CRM?
      - Can I attach an existing tag to a specific contact?
      instructions:
      - text: Add tag {tagId} to contact {contactId}.
        slots:
          tagId: path.tagId
          contactId: path.contactId
      - text: Tag contact {contactId} with tag {tagId}.
        slots:
          contactId: path.contactId
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact-tags/{tagId}/contact/{contactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a CRM contact
      effect: destructive
      questions:
      - Can I take a tag off one contact without deleting the tag?
      - What's the way to untag a single contact?
      instructions:
      - text: Remove tag {tagId} from contact {contactId}.
        slots:
          tagId: path.tagId
          contactId: path.contactId
      - text: Untag contact {contactId} of tag {tagId}.
        slots:
          contactId: path.contactId
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact tags with usage counts
      effect: read
      questions:
      - What contact tags exist and how many contacts use each one?
      - Can I search contact tags by name?
      instructions:
      - text: List all contact tags.
      - text: Search contact tags for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact tag
      effect: write
      questions:
      - How do I create a new tag for CRM contacts?
      - Can I set text and background colors on a new contact tag?
      instructions:
      - text: Create a contact tag named {name}.
        slots:
          name: requestBody.name
      - text: Create contact tag {name} with background color {colorBackground}.
        slots:
          name: requestBody.name
          colorBackground: requestBody.colorBackground
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact-tags/{tagId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a contact tag
      effect: write
      questions:
      - Can I rename a contact tag?
      - Is it possible to change a contact tag's colors?
      instructions:
      - text: Rename contact tag {tagId} to {name}.
        slots:
          tagId: path.tagId
          name: requestBody.name
      - text: Set contact tag {tagId} to name {name} with text color {colorText}.
        slots:
          tagId: path.tagId
          name: requestBody.name
          colorText: requestBody.colorText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact-tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact tag
      effect: destructive
      questions:
      - Can I delete a contact tag entirely?
      - What happens if I remove a contact tag that contacts are using?
      instructions:
      - text: Delete contact tag {tagId}.
        slots:
          tagId: path.tagId
      - text: Remove the contact tag {tagId} from the CRM.
        slots:
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'