# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Encharge People API
  version: 1.0.0
extends: openapi/encharge-people-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['/people'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up specific people
      effect: read
      questions:
      - How do I look up a contact by email?
      - Can I include archived people when fetching specific contacts?
      - Which custom fields can I return for a person I look up?
      instructions:
      - text: Look up the people matching {people}.
        slots:
          people: query.people
      - text: Find {people} and return the fields {attributes}.
        slots:
          people: query.people
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/people'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update people
      effect: write
      questions:
      - How do I add new contacts or update existing ones in one call?
      - What happens if a person I send already exists in Encharge?
      instructions:
      - text: Create or update these people in Encharge.
      - text: Upsert this batch of contacts, matching existing ones by email or ID.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/people'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive or delete people
      effect: destructive
      questions:
      - How do I archive contacts I no longer want to email?
      - Can I fully delete a person's data for a GDPR request?
      instructions:
      - text: Archive the people {people}.
        slots:
          people: query.people
      - text: Permanently delete {people} and all their data for GDPR, force {force}.
        slots:
          people: query.people
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/people/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List all people in the account
      effect: read
      questions:
      - How do I export every contact in my account?
      - Can I skip anonymous visitors when listing all people?
      instructions:
      - text: List all people in my account.
      - text: List {limit} people starting at offset {offset}, sorted by {sort}.
        slots:
          limit: query.limit
          offset: query.offset
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/people/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a person from email
      effect: write
      questions:
      - How do I stop a contact from getting any more emails?
      - Can I unsubscribe someone using my own userId instead of their email?
      instructions:
      - text: Unsubscribe {email} from all email.
        slots:
          email: query.email
      - text: Unsubscribe the person with userId {userId}.
        slots:
          userId: query.userId
      method: generated
      generated: '2026-10-01'