Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Tags Management API

6 actions 6 updates phrasing extends openapi/encharge-tags-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Encharge's API. It is a proposal applied on top of the contract, not a document Encharge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/tags-management'].get
$.paths['/tags-management'].post
$.paths['/tags-management/counts'].get
$.paths['/tags-management/{tag}'].delete
$.paths['/tags-management/{tag}'].patch

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 Encharge Tags Management API
  version: 1.0.0
extends: openapi/encharge-tags-management-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['/tags-management'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tags in the account
      effect: read
      questions:
      - What tags exist in my account?
      - How do I get the full list of tags I can apply?
      instructions:
      - text: List all my tags.
      - text: Show every tag defined in the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags-management'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new tags
      effect: write
      questions:
      - How do I create tags before applying them to anyone?
      - Can I add several new tags to the account at once?
      instructions:
      - text: Create the tags {tags}.
        slots:
          tags: requestBody.tags
      - text: Add {tags} to my account's tag list.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags-management/counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tags with people counts
      effect: read
      questions:
      - How many people have each tag?
      - Which of my tags are used the most?
      instructions:
      - text: Show each tag with the number of people tagged.
      - text: Give me the tag usage counts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags-management/{tag}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag from the account
      effect: destructive
      questions:
      - How do I delete a tag everywhere in my account?
      - Does deleting a tag remove it from every person who has it?
      instructions:
      - text: Delete the tag {tag} from my account.
        slots:
          tag: path.tag
      - text: Remove {tag} from the account and from everyone tagged with it.
        slots:
          tag: path.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags-management/{tag}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a tag
      effect: write
      questions:
      - How do I rename a tag across all flows and segments?
      - Can I change a tag's color or description?
      instructions:
      - text: Rename tag {tag} everywhere.
        slots:
          tag: path.tag
      - text: Set the color of tag {tag} to {color}.
        slots:
          tag: path.tag
          color: requestBody.color
      method: generated
      generated: '2026-10-01'