Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Tags API

3 actions 3 updates phrasing extends openapi/encharge-tags-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 3

$.info
$.paths['/tags'].post
$.paths['/tags'].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 Encharge Tags API
  version: 1.0.0
extends: openapi/encharge-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: 2
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a person
      effect: write
      questions:
      - How do I add a tag to a contact?
      - Can I add several tags to a person at once?
      instructions:
      - text: Tag {email} with {tag}.
        slots:
          email: requestBody.email
          tag: requestBody.tag
      - text: Add tags {tag} to the person with userId {userId}.
        slots:
          tag: requestBody.tag
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a person
      effect: destructive
      questions:
      - How do I take a tag off a contact?
      - Can I remove multiple tags from one person in a single call?
      instructions:
      - text: Remove tag {tag} from {email}.
        slots:
          tag: requestBody.tag
          email: requestBody.email
      - text: Untag the person with userId {userId}, removing {tag}.
        slots:
          userId: requestBody.userId
          tag: requestBody.tag
      method: generated
      generated: '2026-10-01'